aboutsummaryrefslogtreecommitdiff
path: root/src/guff/api-methods.cr
blob: dc0e1e8ff49d95d2428247d587ada4019b3bcc72 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
require "json"
require "./handler"

module Guff
  module APIMethods
    API = {
      "post": {
        "get_posts": {
          text: "Get posts matching query.",

          args: {
            "q": {
              text:     "Search string.",
              type:     :text,
              required: false,
              default:  "",
            },

            "page": {
              text:     "Page number",
              type:     :int,
              required: false,
              default:  "1",
            },

            "tags": {
              text:     "Comma-separated list of tags (union)",
              type:     :tags,
              required: false,
              default:  "1",
            },

            "sort": {
              text:     "Sort order of results",
              type:     :sort,
              required: false,
              default:  "date,desc",
            },
          },
        },
      },

      "test": {
        "version": {
          text: "Get version",
        },

        "get_posts": {
          text: "Test get posts",
        },

        "error": {
          text: "Test error response",
        },
      }
    }

    TYPE_CHECKS = {
      text: /.*/,
      int:  /^\d+$/,
      tags: /^[a-z0-9_,-]+$/,
      sort: /^[a-z0-9_]+,(?:asc|desc)$/,
    }

    private def get_method_args(
      params    : HTTP::Params,
      namespace : String,
      method    : String
    )
      return {} of String => String unless (
        API[namespace]? &&
        API[namespace][method] &&
        API[namespace][method][:args]?
      )

      # get method args
      args = API[namespace][method][:args] as \
        Hash(String, Hash(Symbol, String | Symbol | Bool))

      args.keys.reduce({} of String => String) do |r, arg_name|
        arg_data = args[arg_name] as Hash(Symbol, String|Symbol|Bool)

        # check for required parameter
        if arg_data[:required] && !params.has_key?(arg_name)
          raise "missing required parameter: %s" % [arg_name]
        end

        # get value
        val = params.fetch(arg_name, arg_data[:default] as String)

        # check value
        if !TYPE_CHECKS[arg_data[:type]].match(val)
          raise "invalid parameter format: %s" % [arg_name]
        end

        # add value to result
        r[arg_name] = val

        # return result
        r
      end
    end

    ################
    # post methods #
    ################

    private def do_post_get_posts(
      context : HTTP::Server::Context,
      args    : Hash(String, String)
    )
      [{foo: "bar"}, {foo: "asdf"}].to_json
    end

    ################
    # test methods #
    ################

    private def do_test_version(
      context : HTTP::Server::Context,
      args    : Hash(String, String)
    )
      {version: Guff::VERSION}.to_json
    end

    private def do_test_get_posts(
      context : HTTP::Server::Context,
      args    : Hash(String, String)
    )
      [{foo: "bar"}, {foo: "asdf"}].to_json
    end

    private def do_test_error(
      context : HTTP::Server::Context,
      args    : Hash(String, String)
    )
      raise "some random error"
    end
  end
end