haveapi 0.11.1 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2910cb58bad5471ca8abb70e980ab138519bfc21
-  data.tar.gz: 70283cec7cbbe98d68de0078dd6f2c43149dabcd
+SHA256:
+  metadata.gz: cdbc87bdee886f2d6c0063cb3cb4ce06bb42431508ba88ae9de7375432c642bb
+  data.tar.gz: ca75c1bbaed366ef28c8605d6c1f80c204066cdb7dc09a2e44e4e0a08bb0b52b
 SHA512:
-  metadata.gz: 2b2d482ded9ef0c1bf44f74245a170d068eb51d298d2eadcbf85d9f4853d305c98788e581f2de37567586e5612383cfe5350cd4aab37827db75ae2cd02e5ef03
-  data.tar.gz: 7a5b2316291159eaca2ff05871213e2153cd0732b339699d26c00b1dd525d99129965457c682c61beedae0cc9661512de13a09f8168847b7bee29783c141a8bb
+  metadata.gz: c41b7a81996a2cde3e59b813e9d59d0494338f17f1a67319da23c9aa801c4e79459af8d62c5ac1f76796efd9168c4640e397cc25385e2bcd673ef53a931593c2
+  data.tar.gz: b8a884d61fbe5a2b683f557de99d1c0c6514e16db2666c010e0e9a110a1c41ed0787cee151dbdf1ab939c94d19cde183c390bc4a98aa6fd5d781880fb82c910d

data/CHANGELOG

@@ -1,3 +1,5 @@
+* See ../../CHANGELOG.md for newer versions
+
 * Wed Mar 14 2018 - version 0.11.1
 - Downgrade require_all to v1.5
 

data/Gemfile

@@ -1,6 +1,8 @@
 source 'https://rubygems.org'
 gemspec
 
+gem 'haveapi-client', path: '../../clients/ruby'
+
 group :test do
   gem 'rspec'
   gem 'rack-test'

data/haveapi.gemspec

@@ -5,7 +5,7 @@ require 'haveapi/version'
 Gem::Specification.new do |s|
   s.name        = 'haveapi'
   s.version     = HaveAPI::VERSION
-  s.date        = '2018-03-14'
+  s.date        = '2017-11-27'
   s.summary     =
   s.description = 'Framework for creating self-describing APIs'
   s.authors     = 'Jakub Skokan'
@@ -15,15 +15,15 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = '>= 2.0.0'
 
-  s.add_runtime_dependency 'require_all', '~> 1.5.0'
+  s.add_runtime_dependency 'require_all', '~> 2.0.0'
   s.add_runtime_dependency 'json'
   s.add_runtime_dependency 'activesupport', '>= 4.0'
-  s.add_runtime_dependency 'sinatra', '~> 1.4'
-  s.add_runtime_dependency 'tilt', '~> 1.4'
+  s.add_runtime_dependency 'sinatra', '~> 2.0.5'
+  s.add_runtime_dependency 'tilt', '~> 2.0.9'
   s.add_runtime_dependency 'redcarpet', '~> 3.4'
   s.add_runtime_dependency 'rake'
   s.add_runtime_dependency 'github-markdown'
   s.add_runtime_dependency 'nesty', '~> 1.0'
-  s.add_runtime_dependency 'haveapi-client', '~> 0.10.0'
+  s.add_runtime_dependency 'haveapi-client', '~> 0.12.0'
   s.add_runtime_dependency 'mail'
 end

data/lib/haveapi/action.rb

@@ -1,3 +1,7 @@
+require 'haveapi/common'
+require 'haveapi/hooks'
+require 'haveapi/metadata'
+
 module HaveAPI
   class Action < Common
     obj_type :action
@@ -167,7 +171,7 @@ module HaveAPI
       end
 
       def example(title = '', &block)
-        @examples ||= []
+        @examples ||= ExampleList.new
         e = Example.new(title)
         e.instance_eval(&block)
         @examples << e
@@ -209,7 +213,7 @@ module HaveAPI
             input: @input ? @input.describe(context) : {parameters: {}},
             output: @output ? @output.describe(context) : {parameters: {}},
             meta: @meta ? @meta.merge(@meta) { |_, v| v && v.describe(context) } : nil,
-            examples: @examples ? @examples.map { |e| e.describe } : [],
+            examples: @examples ? @examples.describe(context) : [],
             url: context.resolved_url,
             method: route_method,
             help: "#{context.url}?method=#{route_method}"
@@ -547,9 +551,6 @@ module HaveAPI
                 self.class.model_adapter(self.class.input.layout).input(@safe_params[input.namespace]))
         end
 
-        # Remove duplicit key
-        @safe_params.delete(input.namespace.to_s)
-
         # Now check required params, convert types and set defaults
         input.validate(@safe_params)
       end

data/lib/haveapi/actions/default.rb

@@ -1,3 +1,6 @@
+require 'haveapi/action'
+require 'haveapi/actions/paginable'
+
 module HaveAPI
   module Actions
     module Default

data/lib/haveapi/authentication/basic/provider.rb

@@ -1,3 +1,5 @@
+require 'haveapi/authentication/base'
+
 module HaveAPI::Authentication
   module Basic
     # HTTP basic authentication provider.

data/lib/haveapi/authentication/token/provider.rb

@@ -1,3 +1,5 @@
+require 'haveapi/authentication/base'
+
 module HaveAPI::Authentication
   module Token
     # Exception that has to be raised when generated token already exists.

data/lib/haveapi/authentication/token/resources.rb

@@ -1,3 +1,6 @@
+require 'haveapi/resource'
+require 'haveapi/action'
+
 module HaveAPI::Authentication::Token
   module Resources
     class Token < HaveAPI::Resource

data/lib/haveapi/client_examples/curl.rb

@@ -1,4 +1,5 @@
 require 'pp'
+require 'haveapi/client_examples/http'
 
 module HaveAPI::ClientExamples
   class Curl < Http

data/lib/haveapi/client_examples/fs_client.rb

@@ -1,3 +1,5 @@
+require 'haveapi/client_example'
+
 module HaveAPI::ClientExamples
   class FsClient < HaveAPI::ClientExample
     label 'File system'

data/lib/haveapi/client_examples/http.rb

@@ -1,6 +1,7 @@
 require 'pp'
 require 'cgi'
 require 'rack/utils'
+require 'haveapi/client_example'
 
 module HaveAPI::ClientExamples
   class Http < HaveAPI::ClientExample

data/lib/haveapi/client_examples/js_client.rb

@@ -1,3 +1,5 @@
+require 'haveapi/client_example'
+
 module HaveAPI::ClientExamples
   class JsClient < HaveAPI::ClientExample
     label 'JavaScript'

data/lib/haveapi/client_examples/php_client.rb

@@ -1,3 +1,5 @@
+require 'haveapi/client_example'
+
 module HaveAPI::ClientExamples
   class PhpClient < HaveAPI::ClientExample
     label 'PHP'

data/lib/haveapi/client_examples/ruby_cli.rb

@@ -3,6 +3,7 @@ module HaveAPI
 end
 
 require 'haveapi/cli/output_formatter'
+require 'haveapi/client_example'
 
 module HaveAPI::ClientExamples
   class RubyCli < HaveAPI::ClientExample

data/lib/haveapi/client_examples/ruby_client.rb

@@ -1,4 +1,5 @@
 require 'pp'
+require 'haveapi/client_example'
 
 module HaveAPI::ClientExamples
   class RubyClient < HaveAPI::ClientExample

data/lib/haveapi/example.rb

@@ -4,6 +4,10 @@ module HaveAPI
       @title = title
     end
 
+    def authorize(&block)
+      @authorization = block
+    end
+
     def url_params(*params)
       @url_params = params
     end
@@ -36,20 +40,29 @@ module HaveAPI
       @comment = str
     end
 
+    def authorized?(context)
+      if (context.endpoint || context.current_user) \
+          && @authorization && !@authorization.call(context.current_user)
+        false
+      else
+        true
+      end
+    end
+
     def provided?
       instance_variables.detect do |v|
         instance_variable_get(v)
       end ? true : false
     end
 
-    def describe
+    def describe(context)
       if provided?
         {
             title: @title,
             comment: @comment,
             url_params: @url_params,
-            request: @request,
-            response: @response,
+            request: filter_input_params(context, @request),
+            response: filter_output_params(context, @response),
             status: @status.nil? ? true : @status,
             message: @message,
             errors: @errors,
@@ -59,5 +72,45 @@ module HaveAPI
         {}
       end
     end
+
+    protected
+    def filter_input_params(context, input)
+      case context.action.input.layout
+      when :object, :hash
+        context.authorization.filter_input(
+          context.action.input.params,
+          ModelAdapters::Hash.output(context, input),
+        )
+
+      when :object_list, :hash_list
+        input.map do |obj|
+          context.authorization.filter_input(
+            context.action.input.params,
+            ModelAdapters::Hash.output(context, obj),
+            true
+          )
+        end
+      end
+    end
+
+    def filter_output_params(context, output)
+      case context.action.output.layout
+      when :object, :hash
+        context.authorization.filter_output(
+          context.action.output.params,
+          ModelAdapters::Hash.output(context, output),
+          true
+        )
+
+      when :object_list, :hash_list
+        output.map do |obj|
+          context.authorization.filter_output(
+            context.action.output.params,
+            ModelAdapters::Hash.output(context, obj),
+            true
+          )
+        end
+      end
+    end
   end
 end

data/lib/haveapi/example_list.rb

@@ -0,0 +1,28 @@
+module HaveAPI
+  class ExampleList
+    def initialize
+      @examples = []
+    end
+
+    # @param example [Example]
+    def <<(example)
+      @examples << example
+    end
+
+    def describe(context)
+      ret = []
+
+      @examples.each do |e|
+        ret << e.describe(context) if e.authorized?(context)
+      end
+
+      ret
+    end
+
+    def each(&block)
+      @examples.each(&block)
+    end
+
+    include Enumerable
+  end
+end

data/lib/haveapi/extensions/action_exceptions.rb

@@ -1,3 +1,5 @@
+require 'haveapi/extensions/base'
+
 module HaveAPI::Extensions
   class ActionExceptions < Base
     class << self

data/lib/haveapi/extensions/exception_mailer.rb

@@ -1,5 +1,6 @@
 require 'net/smtp'
 require 'mail'
+require 'haveapi/extensions/base'
 
 module HaveAPI::Extensions
   # This extension mails exceptions raised during action execution and description

data/lib/haveapi/model_adapters/active_record.rb

@@ -1,3 +1,5 @@
+require 'haveapi/model_adapter'
+
 module HaveAPI::ModelAdapters
   # Adapter for ActiveRecord models.
   class ActiveRecord < ::HaveAPI::ModelAdapter

data/lib/haveapi/model_adapters/hash.rb

@@ -1,3 +1,5 @@
+require 'haveapi/model_adapter'
+
 module HaveAPI::ModelAdapters
   # Simple hash adapter. Model is just a hash of parameters
   # and their values.

data/lib/haveapi/output_formatters/json.rb

@@ -1,3 +1,5 @@
+require 'haveapi/output_formatters/base'
+
 module HaveAPI::OutputFormatters
   class Json < BaseFormatter
     handle 'application/json'

data/lib/haveapi/resource.rb

@@ -1,3 +1,5 @@
+require 'haveapi/common'
+
 module HaveAPI
   class Resource < Common
     obj_type :resource

data/lib/haveapi/resources/action_state.rb

@@ -1,3 +1,5 @@
+require 'haveapi/resource'
+
 module HaveAPI::Resources
   class ActionState < HaveAPI::Resource
     desc 'Browse states of blocking actions'

data/lib/haveapi/server.rb

@@ -1,6 +1,8 @@
 require 'erb'
 require 'redcarpet'
+require 'tilt'
 require 'cgi'
+require 'haveapi/hooks'
 
 module HaveAPI
   class Server
@@ -159,6 +161,10 @@ module HaveAPI
       @root = prefix
 
       @sinatra = Sinatra.new do
+        # Preload template engine for .md -- without this, tilt will not search
+        # for markdown files with extension .md, only .markdown
+        Tilt[:md]
+
         set :views, settings.root + '/views'
         set :public_folder, settings.root + '/public'
         set :bind, '0.0.0.0'
@@ -269,7 +275,7 @@ module HaveAPI
         end
       end
 
-      @sinatra.get %r{#{@root}doc/([^\.]+)[\.md]?} do |f|
+      @sinatra.get %r{#{@root}doc/([^\.]+)(\.md)?} do |f, _|
         content_type 'text/html'
         erb :doc_layout, layout: :main_layout do
           begin

data/lib/haveapi/validators/acceptance.rb

@@ -1,3 +1,5 @@
+require 'haveapi/validator'
+
 module HaveAPI
   # Accepts a single configured value.
   #

data/lib/haveapi/validators/confirmation.rb

@@ -1,3 +1,5 @@
+require 'haveapi/validator'
+
 module HaveAPI
   # Checks that two parameters are equal or not equal.
   #

data/lib/haveapi/validators/custom.rb

@@ -1,3 +1,5 @@
+require 'haveapi/validator'
+
 module HaveAPI
   # Custom validator. It has only a short form, taking the description
   # of the validator. This validator passes every value. It is up to the

data/lib/haveapi/validators/exclusion.rb

@@ -1,3 +1,5 @@
+require 'haveapi/validator'
+
 module HaveAPI
   # Checks that the value is not reserved.
   #

data/lib/haveapi/validators/format.rb

@@ -1,3 +1,5 @@
+require 'haveapi/validator'
+
 module HaveAPI
   # Checks that the value is or is not in specified format.
   #

data/lib/haveapi/validators/inclusion.rb

@@ -1,3 +1,5 @@
+require 'haveapi/validator'
+
 module HaveAPI
   # Checks that the value is from given set of allowed values.
   #

data/lib/haveapi/validators/length.rb

@@ -1,3 +1,5 @@
+require 'haveapi/validator'
+
 module HaveAPI
   # Checks the length of a string. It does not have a short form.
   #

data/lib/haveapi/validators/numericality.rb

@@ -1,3 +1,5 @@
+require 'haveapi/validator'
+
 module HaveAPI
   # Checks the value is a number or a string containing only digits.
   #
@@ -8,7 +10,7 @@ module HaveAPI
   #     step: 2,
   #     message: 'the error message'
   #   }
-  # 
+  #
   # Will allow values +3+, +5+, +7+ and +9+.
   #
   #   string :param, number: {
@@ -16,7 +18,7 @@ module HaveAPI
   #     max: 10,
   #     mod: 2,
   #   }
-  # 
+  #
   # Will allow values +4+, +6+, +8+ and +10+.
   class Validators::Numericality < Validator
     name :number
@@ -47,17 +49,17 @@ module HaveAPI
         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"

data/lib/haveapi/validators/presence.rb

@@ -1,3 +1,5 @@
+require 'haveapi/validator'
+
 module HaveAPI
   # Checks the value is present and not empty.
   #

data/lib/haveapi/version.rb

@@ -1,4 +1,4 @@
 module HaveAPI
   PROTOCOL_VERSION = '1.2'
-  VERSION = '0.11.1'
+  VERSION = '0.12.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: haveapi
 version: !ruby/object:Gem::Version
-  version: 0.11.1
+  version: 0.12.0
 platform: ruby
 authors:
 - Jakub Skokan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-14 00:00:00.000000000 Z
+date: 2017-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: require_all
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -58,28 +58,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: 2.0.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: 2.0.5
 - !ruby/object:Gem::Dependency
   name: tilt
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: 2.0.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: 2.0.9
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -142,14 +142,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 0.12.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 0.12.0
 - !ruby/object:Gem::Dependency
   name: mail
   requirement: !ruby/object:Gem::Requirement
@@ -207,6 +207,7 @@ files:
 - lib/haveapi/common.rb
 - lib/haveapi/context.rb
 - lib/haveapi/example.rb
+- lib/haveapi/example_list.rb
 - lib/haveapi/exceptions.rb
 - lib/haveapi/extensions/action_exceptions.rb
 - lib/haveapi/extensions/base.rb
@@ -303,7 +304,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Framework for creating self-describing APIs