daazweb-api 0.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/LICENSE +21 -0
- data/README.markdown +0 -0
- data/lib/daazweb-api/api_request.rb +153 -0
- data/lib/daazweb-api/daazweb_api_error.rb +29 -0
- data/lib/daazweb-api/request.rb +95 -0
- data/lib/daazweb-api/response.rb +10 -0
- data/lib/daazweb-api/version.rb +3 -0
- data/lib/daazweb-api.rb +59 -0
- data/lib/generators/daazweb-api/install/USAGE +2 -0
- data/lib/generators/daazweb-api/install/install_generator.rb +13 -0
- data/lib/generators/daazweb-api/install/templates/daazweb-api.rb +16 -0
- data/lib/generators/daazweb-api/install/templates/daazweb-api.yml +8 -0
- metadata +82 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 484571454e50936709e7e7484547c11b58367b69764a3c3acba6280215fd8f1d
|
4
|
+
data.tar.gz: 7f1dc04edb072012156fde4878c25b80884cee19e5902c794a1fb8c44d4efced
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: b0614d06213ef039ab8579e5860a687433928859dcf95136a331f06c478c8c03f121743893bd3cd6dc409b8f81f5ac48d30c835d9a6d1570d106e42ec419a7b6
|
7
|
+
data.tar.gz: 7e6639535f56097b0610613e5ff919ad4165456da63d89ab6b86f1b948fd527bb85505d49a9b9b0a32d3b0d573b0b24eb1312ea25cf21878c6dacfc983db277f
|
data/LICENSE
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
MIT License
|
2
|
+
|
3
|
+
Copyright (c) 2022
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
13
|
+
copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
21
|
+
SOFTWARE.
|
data/README.markdown
ADDED
File without changes
|
@@ -0,0 +1,153 @@
|
|
1
|
+
module DaazwebApi
|
2
|
+
class APIRequest
|
3
|
+
|
4
|
+
def initialize(builder: nil)
|
5
|
+
@request_builder = builder
|
6
|
+
end
|
7
|
+
|
8
|
+
def post(params: nil, headers: nil, suffix: nil, body: {}, first_time: true)
|
9
|
+
validate_api_key
|
10
|
+
begin
|
11
|
+
response = self.rest_client(suffix).post do |request|
|
12
|
+
configure_request(request: request, params: params, headers: headers, body: body)
|
13
|
+
end
|
14
|
+
parse_response(response)
|
15
|
+
rescue => e
|
16
|
+
handle_error(e)
|
17
|
+
end
|
18
|
+
end
|
19
|
+
|
20
|
+
def get(params: nil, headers: nil, body: {}, first_time: true)
|
21
|
+
validate_api_key
|
22
|
+
|
23
|
+
begin
|
24
|
+
response = self.rest_client.get do |request|
|
25
|
+
configure_request(request: request, params: params, headers: headers, body: body)
|
26
|
+
end
|
27
|
+
parse_response(response)
|
28
|
+
rescue => e
|
29
|
+
handle_error(e)
|
30
|
+
end
|
31
|
+
end
|
32
|
+
|
33
|
+
protected
|
34
|
+
|
35
|
+
# Convenience accessors
|
36
|
+
|
37
|
+
def access_token
|
38
|
+
@request_builder.access_token
|
39
|
+
end
|
40
|
+
|
41
|
+
def timeout
|
42
|
+
@request_builder.timeout
|
43
|
+
end
|
44
|
+
|
45
|
+
def open_timeout
|
46
|
+
@request_builder.open_timeout
|
47
|
+
end
|
48
|
+
|
49
|
+
def proxy
|
50
|
+
@request_builder.proxy
|
51
|
+
end
|
52
|
+
|
53
|
+
def ssl_options
|
54
|
+
@request_builder.ssl_options
|
55
|
+
end
|
56
|
+
|
57
|
+
def adapter
|
58
|
+
@request_builder.faraday_adapter
|
59
|
+
end
|
60
|
+
|
61
|
+
def symbolize_keys
|
62
|
+
@request_builder.symbolize_keys
|
63
|
+
end
|
64
|
+
|
65
|
+
# Helpers
|
66
|
+
|
67
|
+
def handle_error(error)
|
68
|
+
error_params = {}
|
69
|
+
|
70
|
+
begin
|
71
|
+
if error.is_a?(Faraday::ClientError) && error.response
|
72
|
+
error_params[:status_code] = error.response[:status]
|
73
|
+
error_params[:raw_body] = error.response[:body]
|
74
|
+
|
75
|
+
parsed_response = MultiJson.load(error.response[:body], symbolize_keys: symbolize_keys)
|
76
|
+
|
77
|
+
if parsed_response
|
78
|
+
error_params[:body] = parsed_response
|
79
|
+
|
80
|
+
title_key = symbolize_keys ? :title : "title"
|
81
|
+
detail_key = symbolize_keys ? :detail : "detail"
|
82
|
+
|
83
|
+
error_params[:title] = parsed_response[title_key] if parsed_response[title_key]
|
84
|
+
error_params[:detail] = parsed_response[detail_key] if parsed_response[detail_key]
|
85
|
+
end
|
86
|
+
|
87
|
+
end
|
88
|
+
rescue MultiJson::ParseError
|
89
|
+
end
|
90
|
+
|
91
|
+
error_to_raise = DaazwebApiError.new(error.message, error_params)
|
92
|
+
|
93
|
+
raise error_to_raise
|
94
|
+
end
|
95
|
+
|
96
|
+
def configure_request(request: nil, params: nil, headers: nil, body: nil)
|
97
|
+
if request
|
98
|
+
request.params.merge!(params) if params
|
99
|
+
request.headers['Content-Type'] = 'application/json'
|
100
|
+
request.headers['Authorization'] = "Bearer #{DaazwebApi::Request.access_token}"
|
101
|
+
request.headers['User-Agent'] = "DaazwebApi/#{DaazwebApi::VERSION} Ruby gem"
|
102
|
+
request.headers.merge!(headers) if headers
|
103
|
+
request.body = MultiJson.dump(body) if body
|
104
|
+
request.options.timeout = self.timeout
|
105
|
+
request.options.open_timeout = self.open_timeout
|
106
|
+
end
|
107
|
+
end
|
108
|
+
|
109
|
+
def rest_client(suffix=nil)
|
110
|
+
client = Faraday.new("#{self.api_url}#{suffix.present? ? "/#{suffix}": ""}", proxy: self.proxy,
|
111
|
+
ssl: { version: self.ssl_options }) do |faraday|
|
112
|
+
faraday.response :raise_error
|
113
|
+
faraday.adapter adapter
|
114
|
+
if @request_builder.debug
|
115
|
+
faraday.response :logger, @request_builder.logger, bodies: true
|
116
|
+
end
|
117
|
+
end
|
118
|
+
client
|
119
|
+
end
|
120
|
+
|
121
|
+
def parse_response(response)
|
122
|
+
parsed_response = nil
|
123
|
+
|
124
|
+
if response.body && !response.body.empty?
|
125
|
+
begin
|
126
|
+
headers = response.headers
|
127
|
+
body = MultiJson.load(response.body, symbolize_keys: symbolize_keys)
|
128
|
+
parsed_response = Response.new(headers: headers, body: body)
|
129
|
+
rescue MultiJson::ParseError
|
130
|
+
error_params = { title: "UNPARSEABLE_RESPONSE", status_code: 500 }
|
131
|
+
error = DaazwebApiError.new("Unparseable response: #{response.body}", error_params)
|
132
|
+
raise error
|
133
|
+
end
|
134
|
+
end
|
135
|
+
|
136
|
+
parsed_response
|
137
|
+
end
|
138
|
+
|
139
|
+
def validate_api_key
|
140
|
+
unless self.access_token
|
141
|
+
raise DaazwebApi::DaazwebApiError, "You must set an access_token to making a call #{DaazwebApi::API_ENDPOINT}"
|
142
|
+
end
|
143
|
+
end
|
144
|
+
|
145
|
+
def api_url
|
146
|
+
base_api_url + @request_builder.path
|
147
|
+
end
|
148
|
+
|
149
|
+
def base_api_url
|
150
|
+
"#{DaazwebApi::API_ENDPOINT}/api/"
|
151
|
+
end
|
152
|
+
end
|
153
|
+
end
|
@@ -0,0 +1,29 @@
|
|
1
|
+
module DaazwebApi
|
2
|
+
class DaazwebApiError < StandardError
|
3
|
+
attr_reader :title, :detail, :body, :raw_body, :status_code
|
4
|
+
|
5
|
+
def initialize(message = "", params = {})
|
6
|
+
@title = params[:title]
|
7
|
+
@detail = params[:detail]
|
8
|
+
@body = params[:body]
|
9
|
+
@raw_body = params[:raw_body]
|
10
|
+
@status_code = params[:status_code]
|
11
|
+
|
12
|
+
super(message)
|
13
|
+
end
|
14
|
+
|
15
|
+
def to_s
|
16
|
+
super + " " + instance_variables_to_s
|
17
|
+
end
|
18
|
+
|
19
|
+
private
|
20
|
+
|
21
|
+
def instance_variables_to_s
|
22
|
+
[:title, :detail, :body, :raw_body, :status_code].map do |attr|
|
23
|
+
attr_value = send(attr)
|
24
|
+
|
25
|
+
"@#{attr}=#{attr_value.inspect}"
|
26
|
+
end.join(", ")
|
27
|
+
end
|
28
|
+
end
|
29
|
+
end
|
@@ -0,0 +1,95 @@
|
|
1
|
+
module DaazwebApi
|
2
|
+
class Request
|
3
|
+
attr_accessor :access_token, :timeout, :open_timeout, :proxy, :ssl_options, :faraday_adapter, :symbolize_keys,
|
4
|
+
:debug, :logger, :test
|
5
|
+
|
6
|
+
DEFAULT_TIMEOUT = 60
|
7
|
+
DEFAULT_OPEN_TIMEOUT = 60
|
8
|
+
|
9
|
+
def initialize(access_token: nil, timeout: nil, open_timeout: nil, proxy: nil, ssl_options: nil,
|
10
|
+
faraday_adapter: nil, symbolize_keys: false, debug: false, logger: nil, test: false)
|
11
|
+
|
12
|
+
@path_parts = []
|
13
|
+
@access_token = access_token || self.class.access_token || DaazwebApi.generate_access_token.try(:dig, "access_token")
|
14
|
+
@timeout = timeout || self.class.timeout || DEFAULT_TIMEOUT
|
15
|
+
@open_timeout = open_timeout || self.class.open_timeout || DEFAULT_OPEN_TIMEOUT
|
16
|
+
@proxy = proxy || self.class.proxy || ENV['DAAZWEB_API_PROXY']
|
17
|
+
@ssl_options = ssl_options || self.class.ssl_options || { version: "TLSv1_2" }
|
18
|
+
@faraday_adapter = faraday_adapter || self.class.faraday_adapter || Faraday.default_adapter
|
19
|
+
@symbolize_keys = symbolize_keys || self.class.symbolize_keys || false
|
20
|
+
@debug = debug || self.class.debug || false
|
21
|
+
@test = test || self.class.test || false
|
22
|
+
@logger = logger || self.class.logger || ::Logger.new(STDOUT)
|
23
|
+
end
|
24
|
+
|
25
|
+
def method_missing(method, *args)
|
26
|
+
@path_parts << method.to_s.gsub("_", "-").downcase
|
27
|
+
@path_parts << args if args.length > 0
|
28
|
+
@path_parts.flatten!
|
29
|
+
self
|
30
|
+
end
|
31
|
+
|
32
|
+
def respond_to_missing?(method_name, include_private = false)
|
33
|
+
true
|
34
|
+
end
|
35
|
+
|
36
|
+
def send(*args)
|
37
|
+
if args.length == 0
|
38
|
+
method_missing(:send, args)
|
39
|
+
else
|
40
|
+
__send__(*args)
|
41
|
+
end
|
42
|
+
end
|
43
|
+
|
44
|
+
def path
|
45
|
+
@path_parts.join('/')
|
46
|
+
end
|
47
|
+
|
48
|
+
def create(params: nil, headers: nil, body: {}, suffix: 'create')
|
49
|
+
APIRequest.new(builder: self).post(params: params, headers: headers, suffix: suffix, body: body)
|
50
|
+
ensure
|
51
|
+
reset
|
52
|
+
end
|
53
|
+
|
54
|
+
def update(params: nil, headers: nil, body: {})
|
55
|
+
APIRequest.new(builder: self).post(params: params, headers: headers, suffix: 'edit', body: body)
|
56
|
+
ensure
|
57
|
+
reset
|
58
|
+
end
|
59
|
+
|
60
|
+
def retrieve(params: nil, headers: nil, body: {})
|
61
|
+
APIRequest.new(builder: self).get(params: params, headers: headers, body: body)
|
62
|
+
ensure
|
63
|
+
reset
|
64
|
+
end
|
65
|
+
|
66
|
+
def delete(params: nil, headers: nil, body: {})
|
67
|
+
APIRequest.new(builder: self).post(params: params, headers: headers, body: {}, suffix: 'delete')
|
68
|
+
ensure
|
69
|
+
reset
|
70
|
+
end
|
71
|
+
|
72
|
+
protected
|
73
|
+
|
74
|
+
def reset
|
75
|
+
@path_parts = []
|
76
|
+
end
|
77
|
+
|
78
|
+
class << self
|
79
|
+
attr_accessor :access_token, :timeout, :open_timeout, :proxy, :ssl_options, :faraday_adapter, :symbolize_keys,
|
80
|
+
:debug, :logger, :test
|
81
|
+
|
82
|
+
def method_missing(sym, *args, &block)
|
83
|
+
new(access_token: self.access_token,
|
84
|
+
timeout: self.timeout, open_timeout: self.open_timeout, faraday_adapter: self.faraday_adapter,
|
85
|
+
symbolize_keys: self.symbolize_keys, debug: self.debug, proxy: self.proxy, ssl_options: self.ssl_options,
|
86
|
+
logger: self.logger,
|
87
|
+
test: self.test).send(sym, *args, &block)
|
88
|
+
end
|
89
|
+
|
90
|
+
def respond_to_missing?(method_name, include_private = false)
|
91
|
+
true
|
92
|
+
end
|
93
|
+
end
|
94
|
+
end
|
95
|
+
end
|
data/lib/daazweb-api.rb
ADDED
@@ -0,0 +1,59 @@
|
|
1
|
+
require 'faraday'
|
2
|
+
require 'daazweb-api/version'
|
3
|
+
require 'daazweb-api/daazweb_api_error'
|
4
|
+
require 'daazweb-api/request'
|
5
|
+
require 'daazweb-api/api_request'
|
6
|
+
require 'daazweb-api/response'
|
7
|
+
|
8
|
+
module DaazwebApi
|
9
|
+
|
10
|
+
API_ENDPOINT = "https://daazweb.space/api/"
|
11
|
+
|
12
|
+
class << self
|
13
|
+
def setup
|
14
|
+
yield self
|
15
|
+
end
|
16
|
+
|
17
|
+
def register(name, value, type = nil)
|
18
|
+
cattr_accessor "#{name}_setting".to_sym
|
19
|
+
|
20
|
+
add_reader(name)
|
21
|
+
add_writer(name, type)
|
22
|
+
send "#{name}=", value
|
23
|
+
end
|
24
|
+
|
25
|
+
def add_reader(name)
|
26
|
+
define_singleton_method(name) do |*args|
|
27
|
+
send("#{name}_setting").value(*args)
|
28
|
+
end
|
29
|
+
end
|
30
|
+
|
31
|
+
def add_writer(name, type)
|
32
|
+
define_singleton_method("#{name}=") do |value|
|
33
|
+
send("#{name}_setting=", DynamicSetting.build(value, type))
|
34
|
+
end
|
35
|
+
end
|
36
|
+
end
|
37
|
+
|
38
|
+
class DynamicSetting
|
39
|
+
def self.build(setting, type)
|
40
|
+
(type ? klass(type) : self).new(setting)
|
41
|
+
end
|
42
|
+
|
43
|
+
def self.klass(type)
|
44
|
+
klass = "#{type.to_s.camelcase}Setting"
|
45
|
+
raise ArgumentError, "Unknown type: #{type}" unless DaazwebApi.const_defined?(klass)
|
46
|
+
DaazwebApi.const_get(klass)
|
47
|
+
end
|
48
|
+
|
49
|
+
def initialize(setting)
|
50
|
+
@setting = setting
|
51
|
+
end
|
52
|
+
|
53
|
+
def value(*_args)
|
54
|
+
@setting
|
55
|
+
end
|
56
|
+
end
|
57
|
+
end
|
58
|
+
|
59
|
+
enable :inline_templates
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module DaazwebApi
|
4
|
+
class InstallGenerator < Rails::Generators::Base
|
5
|
+
source_root File.expand_path('templates', __dir__)
|
6
|
+
|
7
|
+
def generate_install
|
8
|
+
copy_file 'daazweb-api.yml', 'config/daazweb-api.yml'
|
9
|
+
copy_file 'daazweb-api.rb', 'config/initializers/daazweb-api.rb'
|
10
|
+
end
|
11
|
+
end
|
12
|
+
end
|
13
|
+
|
@@ -0,0 +1,16 @@
|
|
1
|
+
require 'daazweb-api'
|
2
|
+
|
3
|
+
DaazwebApi.setup do |config|
|
4
|
+
if File.exist?('config/daazweb-api.yml')
|
5
|
+
processed = YAML.load_file('config/daazweb-api.yml')[Rails.env]
|
6
|
+
|
7
|
+
processed.each do |k, v|
|
8
|
+
config::register k.underscore.to_sym, v
|
9
|
+
end
|
10
|
+
|
11
|
+
config::Request.timeout = 60
|
12
|
+
config::Request.open_timeout = 60
|
13
|
+
config::Request.symbolize_keys = true
|
14
|
+
config::Request.debug = false
|
15
|
+
end
|
16
|
+
end
|
metadata
ADDED
@@ -0,0 +1,82 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: daazweb-api
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.0.1
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Pavel Osetrov
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2022-06-17 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: faraday
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - ">="
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: 0.16.0
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - ">="
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: 0.16.0
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: multi_json
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - ">="
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: 1.11.0
|
34
|
+
type: :runtime
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - ">="
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: 1.11.0
|
41
|
+
description: ''
|
42
|
+
email: pavel.osetrov@me.com
|
43
|
+
executables: []
|
44
|
+
extensions: []
|
45
|
+
extra_rdoc_files: []
|
46
|
+
files:
|
47
|
+
- LICENSE
|
48
|
+
- README.markdown
|
49
|
+
- lib/daazweb-api.rb
|
50
|
+
- lib/daazweb-api/api_request.rb
|
51
|
+
- lib/daazweb-api/daazweb_api_error.rb
|
52
|
+
- lib/daazweb-api/request.rb
|
53
|
+
- lib/daazweb-api/response.rb
|
54
|
+
- lib/daazweb-api/version.rb
|
55
|
+
- lib/generators/daazweb-api/install/USAGE
|
56
|
+
- lib/generators/daazweb-api/install/install_generator.rb
|
57
|
+
- lib/generators/daazweb-api/install/templates/daazweb-api.rb
|
58
|
+
- lib/generators/daazweb-api/install/templates/daazweb-api.yml
|
59
|
+
homepage: https://daazweb.space/api/
|
60
|
+
licenses:
|
61
|
+
- MIT
|
62
|
+
metadata: {}
|
63
|
+
post_install_message:
|
64
|
+
rdoc_options: []
|
65
|
+
require_paths:
|
66
|
+
- lib
|
67
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
68
|
+
requirements:
|
69
|
+
- - ">="
|
70
|
+
- !ruby/object:Gem::Version
|
71
|
+
version: 2.3.8
|
72
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
73
|
+
requirements:
|
74
|
+
- - ">="
|
75
|
+
- !ruby/object:Gem::Version
|
76
|
+
version: '0'
|
77
|
+
requirements: []
|
78
|
+
rubygems_version: 3.2.32
|
79
|
+
signing_key:
|
80
|
+
specification_version: 4
|
81
|
+
summary: Daazweb API
|
82
|
+
test_files: []
|