haveapi 0.12.1 → 0.13.0

data/lib/haveapi/model_adapters/active_record.rb

@@ -114,7 +114,7 @@ module HaveAPI::ModelAdapters
       def self.used_by(action)
         action.meta(:object) do
           output do
-            custom :url_params, label: 'URL parameters',
+            custom :path_params, label: 'URL parameters',
                    desc: 'An array of parameters needed to resolve URL to this object'
             bool :resolved, label: 'Resolved', desc: 'True if the association is resolved'
           end
@@ -172,14 +172,14 @@ END
         if @context.action.name.demodulize == 'Index' \
            && !@context.action.resolve \
            && res.const_defined?(:Show)
-          params = res::Show.resolve_url_params(@object)
+          params = res::Show.resolve_path_params(@object)
 
         else
-          params = @context.action.resolve_url_params(@object)
+          params = @context.action.resolve_path_params(@object)
         end
 
         {
-            url_params: params.is_a?(Array) ? params : [params],
+            path_params: params.is_a?(Array) ? params : [params],
             resolved: true
         }
       end
@@ -195,7 +195,7 @@ END
         res_show = param.show_action
         res_output = res_show.output
 
-        args = res_show.resolve_url_params(val)
+        args = res_show.resolve_path_params(val)
 
         if includes_include?(param.name)
           push_cls = @context.action
@@ -234,7 +234,7 @@ END
               param.value_id => val.send(res_output[param.value_id].db_name),
               param.value_label => val.send(res_output[param.value_label].db_name),
               _meta: {
-                :url_params => args.is_a?(Array) ? args : [args],
+                :path_params => args.is_a?(Array) ? args : [args],
                 :resolved => false
               }
           }

data/lib/haveapi/parameters/resource.rb

@@ -8,8 +8,8 @@ module HaveAPI::Parameters
         db_name: nil, fetch: nil)
       @resource = resource
       @resource_path = build_resource_path(resource)
-      @name = name || resource.to_s.demodulize.underscore.to_sym
-      @label = label || (name && name.to_s.capitalize) || resource.to_s.demodulize
+      @name = name || resource.resource_name.underscore.to_sym
+      @label = label || (name && name.to_s.capitalize) || resource.resource_name
       @desc = desc
       @choices = choices || @resource::Index
       @value_id = value_id
@@ -42,15 +42,15 @@ module HaveAPI::Parameters
     end
 
     def describe(context)
-      val_url = context.url_for(
+      val_path = context.path_for(
           @resource::Show,
-          context.endpoint && context.action_prepare && context.layout == :object && context.call_url_params(context.action, context.action_prepare)
+          context.endpoint && context.action_prepare && context.layout == :object && context.call_path_params(context.action, context.action_prepare)
       )
       val_method = @resource::Index.http_method.to_s.upcase
 
-      choices_url = context.url_for(
+      choices_path = context.path_for(
           @choices,
-          context.endpoint && context.layout == :object && context.call_url_params(context.action, context.action_prepare)
+          context.endpoint && context.layout == :object && context.call_path_params(context.action, context.action_prepare)
       )
       choices_method = @choices.http_method.to_s.upcase
 
@@ -63,14 +63,14 @@ module HaveAPI::Parameters
           value_id: @value_id,
           value_label: @value_label,
           value: context.action_prepare && {
-              url: val_url,
+              path: val_path,
               method: val_method,
-              help: "#{val_url}?method=#{val_method}",
+              help: "#{val_path}?method=#{val_method}",
           },
           choices: {
-              url: choices_url,
+              path: choices_path,
               method: choices_method,
-              help: "#{choices_url}?method=#{choices_method}"
+              help: "#{choices_path}?method=#{choices_method}"
           }
       }
     end

data/lib/haveapi/params.rb

@@ -68,7 +68,7 @@ module HaveAPI
       return @cache[:namespace] unless @cache[:namespace].nil?
       return @cache[:namespace] = @namespace unless @namespace.nil?
 
-      n = @action.resource.to_s.demodulize.underscore
+      n = @action.resource.resource_name.underscore
       n = n.pluralize if %i(object_list hash_list).include?(layout)
       @cache[:namespace] = n.to_sym
     end

data/lib/haveapi/resource.rb

@@ -49,14 +49,20 @@ module HaveAPI
     end
 
     def self.resource_name
-      ret = self.to_s.demodulize
+      (@resource_name ? @resource_name.to_s : to_s).demodulize
+    end
+
+    def self.resource_name=(name)
+      @resource_name = name
+    end
 
-      singular ? ret.singularize.underscore : ret.tableize
+    def self.rest_name
+      singular ? resource_name.singularize.underscore : resource_name.tableize
     end
 
     def self.routes(prefix='/')
       ret = []
-      prefix = "#{prefix}#{@route || resource_name}/"
+      prefix = "#{prefix}#{@route || rest_name}/"
 
       actions do |a|
         # Call used_by for selected model adapters. It is safe to do
@@ -78,29 +84,29 @@ module HaveAPI
 
       context.resource = self
 
-      hash[:actions].each do |action, url|
+      hash[:actions].each do |action, path|
         context.action = action
-        context.url = url
-
-        a_name = action.to_s.demodulize.underscore
+        context.path = path
 
+        a_name = action.action_name.underscore
         a_desc = action.describe(context)
 
         ret[:actions][a_name] = a_desc if a_desc
       end
 
       hash[:resources].each do |resource, children|
-        ret[:resources][resource.to_s.demodulize.underscore] = resource.describe(children, context)
+        ret[:resources][resource.resource_name.underscore] = resource.describe(children, context)
       end
 
       ret
     end
 
     def self.define_resource(name, superclass: Resource, &block)
-      return false if const_defined?(name)
+      return false if const_defined?(name) && self != HaveAPI::Resource
 
       cls = Class.new(superclass)
-      const_set(name, cls)
+      const_set(name, cls) if self != HaveAPI::Resource
+      cls.resource_name = name
       cls.class_exec(&block) if block
       cls
     end
@@ -110,6 +116,8 @@ module HaveAPI
 
       cls = Class.new(superclass)
       const_set(name, cls)
+      cls.resource = self
+      cls.action_name = name
       superclass.delayed_inherited(cls)
       cls.class_exec(&block)
     end

data/lib/haveapi/resources/action_state.rb

@@ -87,7 +87,7 @@ module HaveAPI::Resources
 
       desc 'Returns when the action is completed or timeout occurs'
       http_method :get
-      route ':%{resource}_id/poll'
+      route '{%{resource}_id}/poll'
 
       input(:hash) do
         float :timeout, label: 'Timeout', desc: 'in seconds', default: 15, fill: true
@@ -159,7 +159,7 @@ module HaveAPI::Resources
 
     class Cancel < HaveAPI::Action
       http_method :post
-      route ':%{resource}_id/cancel'
+      route '{%{resource}_id}/cancel'
       blocking true
 
       output(:hash) {}

data/lib/haveapi/route.rb

@@ -1,9 +1,10 @@
 module HaveAPI
   class Route
-    attr_reader :url, :action
+    attr_reader :path, :sinatra_path, :action
 
-    def initialize(url, action)
-      @url = url
+    def initialize(path, action)
+      @path = path
+      @sinatra_path = path.gsub(/:([a-zA-Z\-_]+)/, '{\1}')
       @action = action
     end
 

data/lib/haveapi/server.rb

@@ -387,7 +387,7 @@ module HaveAPI
           )
 
         else
-          hash[resource][:actions][route.action] = route.url
+          hash[resource][:actions][route.action] = route.path
           mount_action(v, route)
         end
       end
@@ -401,7 +401,7 @@ module HaveAPI
           ret[:resources][route.keys.first] = mount_nested_resource(v, route.values.first)
 
         else
-          ret[:actions][route.action] = route.url
+          ret[:actions][route.action] = route.path
           mount_action(v, route)
         end
       end
@@ -410,7 +410,7 @@ module HaveAPI
     end
 
     def mount_action(v, route)
-      @sinatra.method(route.http_method).call(route.url) do
+      @sinatra.method(route.http_method).call(route.sinatra_path) do
         if route.action.auth
           authenticate!(v)
         else
@@ -437,7 +437,7 @@ module HaveAPI
             version: v,
             request: self,
             action: route.action,
-            url: route.url,
+            path: route.path,
             params: params,
             user: current_user,
             endpoint: true
@@ -462,7 +462,7 @@ module HaveAPI
         ]
       end
 
-      @sinatra.options route.url do |*args|
+      @sinatra.options route.sinatra_path do |*args|
         access_control
         route_method = route.http_method.to_s.upcase
 
@@ -479,7 +479,7 @@ module HaveAPI
             version: v,
             request: self,
             action: route.action,
-            url: route.url,
+            path: route.path,
             args: args,
             params: params,
             user: current_user,
@@ -533,7 +533,7 @@ module HaveAPI
       #puts JSON.pretty_generate(@routes)
 
       @routes[context.version][:resources].each do |resource, children|
-        r_name = resource.to_s.demodulize.underscore
+        r_name = resource.resource_name.underscore
         r_desc = describe_resource(resource, children, context)
 
         unless r_desc[:actions].empty? && r_desc[:resources].empty?

data/lib/haveapi/spec/mock_action.rb

@@ -1,10 +1,10 @@
 module HaveAPI::Spec
   class MockAction
-    def initialize(test, server, action, url, v)
+    def initialize(test, server, action, path, v)
       @test = test
       @server = server
       @action = action
-      @url = url
+      @path = path
       @v = v
     end
 
@@ -13,7 +13,7 @@ module HaveAPI::Spec
           @server,
           version: @v,
           action: @action,
-          url: @url,
+          path: @path,
           params: input,
           user: user,
           endpoint: true

data/lib/haveapi/spec/spec_methods.rb

@@ -26,7 +26,7 @@ module HaveAPI::Spec
     # This method is a wrapper for Rack::Test::Methods. Input parameters
     # are encoded into JSON and sent with a correct Content-Type.
     # Two modes:
-    #   http_method, url, params = {}
+    #   http_method, path, params = {}
     #   [resource], action, params, &block
     def call_api(*args, &block)
       if args[0].is_a?(::Array) || args[1].is_a?(::Symbol)
@@ -34,22 +34,22 @@ module HaveAPI::Spec
 
         app
 
-        action, url = find_action(
+        action, path = find_action(
             (params && params[:version]) || @api.default_version,
             r_name, a_name
         )
 
         method(action.http_method).call(
-            url,
+            path,
             params && params.to_json,
             {'Content-Type' => 'application/json'}
         )
 
       else
-        http_method, url, params = args
+        http_method, path, params = args
 
         method(http_method).call(
-            url,
+            path,
             params && params.to_json,
             {'Content-Type' => 'application/json'}
         )
@@ -77,8 +77,8 @@ module HaveAPI::Spec
     def mock_action(r_name, a_name, params, version: nil, user: nil, &block)
       app
       v = version || @api.default_version
-      action, url = find_action(v, r_name, a_name)
-      m = MockAction.new(self, @api, action, url, v)
+      action, path = find_action(v, r_name, a_name)
+      m = MockAction.new(self, @api, action, path, v)
       m.call(params, user: user, &block)
     end
 
@@ -106,7 +106,7 @@ module HaveAPI::Spec
       resources = r_name.is_a?(::Array) ? r_name : [r_name]
 
       top = @api.routes[v]
-      
+
       resources.each do |r|
         top = top[:resources].detect do |k, _|
           k.resource_name.to_sym == r

data/lib/haveapi/version.rb

@@ -1,4 +1,4 @@
 module HaveAPI
-  PROTOCOL_VERSION = '1.2'
-  VERSION = '0.12.1'
+  PROTOCOL_VERSION = '2.0'
+  VERSION = '0.13.0'
 end

data/lib/haveapi/views/version_page.erb

@@ -86,8 +86,8 @@ end
         <h3 id="<%= "#{prefix}-#{resource}-#{action}" %>"><%= name %> # <%= action.capitalize %></h3>
         <div class="action">
           <dl>
-            <dt>URL:</dt>
-            <dd><%= info[:method] %> <%= info[:url] %></dd>
+            <dt>Path:</dt>
+            <dd><%= info[:method] %> <%= info[:path] %></dd>
             <dt>Description:</dt>
             <dd><%= info[:description] %></dd>
             <dt>Authentication required:</dt>

data/shell.nix

@@ -13,7 +13,7 @@ in stdenv.mkDerivation rec {
 
   shellHook = ''
     export GEM_HOME=$(pwd)/../../.gems
-    export PATH="$GEM_HOME/.gems/bin:$PATH"
+    export PATH="$GEM_HOME/bin:$PATH"
     gem install bundler
     bundle install
   '';

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: haveapi
 version: !ruby/object:Gem::Version
-  version: 0.12.1
+  version: 0.13.0
 platform: ruby
 authors:
 - Jakub Skokan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-27 00:00:00.000000000 Z
+date: 2019-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: require_all
@@ -142,14 +142,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.13.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.13.0
 - !ruby/object:Gem::Dependency
   name: mail
   requirement: !ruby/object:Gem::Requirement
@@ -193,8 +193,12 @@ files:
 - lib/haveapi/authentication/base.rb
 - lib/haveapi/authentication/basic/provider.rb
 - lib/haveapi/authentication/chain.rb
+- lib/haveapi/authentication/token.rb
+- lib/haveapi/authentication/token/action_config.rb
+- lib/haveapi/authentication/token/action_request.rb
+- lib/haveapi/authentication/token/action_result.rb
+- lib/haveapi/authentication/token/config.rb
 - lib/haveapi/authentication/token/provider.rb
-- lib/haveapi/authentication/token/resources.rb
 - lib/haveapi/authorization.rb
 - lib/haveapi/client_example.rb
 - lib/haveapi/client_examples/curl.rb

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

@@ -1,110 +0,0 @@
-require 'haveapi/resource'
-require 'haveapi/action'
-
-module HaveAPI::Authentication::Token
-  module Resources
-    class Token < HaveAPI::Resource
-      auth false
-      version :all
-
-      class << self
-        attr_accessor :token_instance
-      end
-
-      class Request < HaveAPI::Action
-        route ''
-        http_method :post
-
-        input(:hash) do
-          string :login, label: 'Login', required: true
-          password :password, label: 'Password', required: true
-          string :lifetime, label: 'Lifetime', required: true,
-                  choices: %i(fixed renewable_manual renewable_auto permanent),
-                  desc: <<END
-fixed - the token has a fixed validity period, it cannot be renewed
-renewable_manual - the token can be renewed, but it must be done manually via renew action
-renewable_auto - the token is renewed automatically to now+interval every time it is used
-permanent - the token will be valid forever, unless deleted
-END
-          integer :interval, label: 'Interval',
-                  desc: 'How long will requested token be valid, in seconds.',
-                  default: 60*5, fill: true
-        end
-
-        output(:hash) do
-          string :token
-          datetime :valid_to
-        end
-
-        authorize do
-          allow
-        end
-
-        def exec
-          klass = self.class.resource.token_instance[@version]
-
-          user = klass.send(
-              :find_user_by_credentials,
-              request,
-              input[:login],
-              input[:password]
-          )
-          error('bad login or password') unless user
-
-          token = expiration = nil
-
-          loop do
-            begin
-              token = klass.send(:generate_token)
-              expiration = klass.send(:save_token,
-                                      @request,
-                                      user,
-                                      token,
-                                      params[:token][:lifetime],
-                                      params[:token][:interval])
-              break
-
-            rescue TokenExists
-              next
-            end
-          end
-
-          {token: token, valid_to: expiration}
-        end
-      end
-
-      class Revoke < HaveAPI::Action
-        # route ''
-        http_method :post
-        auth true
-
-        authorize do
-          allow
-        end
-
-        def exec
-          klass = self.class.resource.token_instance[@version]
-          klass.send(:revoke_token, request, current_user, klass.token(request))
-        end
-      end
-
-      class Renew < HaveAPI::Action
-        http_method :post
-        auth true
-
-        output(:hash) do
-          datetime :valid_to
-        end
-
-        authorize do
-          allow
-        end
-
-        def exec
-          klass = self.class.resource.token_instance[@version]
-          {valid_to: klass.send(:renew_token, request, current_user, klass.token(request))}
-        end
-      end
-    end
-  end
-end