active_call-doc_fox 0.1.1 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (48) hide show
  1. checksums.yaml +4 -4
  2. data/.rubocop.yml +12 -0
  3. data/CHANGELOG.md +17 -2
  4. data/README.md +445 -17
  5. data/lib/doc_fox/access_token/get_service.rb +5 -1
  6. data/lib/doc_fox/authentication/get_service.rb +7 -1
  7. data/lib/doc_fox/base_service.rb +25 -8
  8. data/lib/doc_fox/concerns/enumerable.rb +3 -1
  9. data/lib/doc_fox/data_requirement/facade.rb +25 -0
  10. data/lib/doc_fox/data_requirement/get_service.rb +53 -0
  11. data/lib/doc_fox/data_requirement/list_service.rb +67 -0
  12. data/lib/doc_fox/document/download_service.rb +81 -0
  13. data/lib/doc_fox/document/facade.rb +22 -0
  14. data/lib/doc_fox/document/get_service.rb +54 -0
  15. data/lib/doc_fox/document/list_service.rb +36 -0
  16. data/lib/doc_fox/document/upload_service.rb +62 -0
  17. data/lib/doc_fox/document_token/create_service.rb +57 -0
  18. data/lib/doc_fox/document_token/facade.rb +15 -0
  19. data/lib/doc_fox/document_token/get_service.rb +46 -0
  20. data/lib/doc_fox/document_token/list_service.rb +36 -0
  21. data/lib/doc_fox/evidence_submission/approve_service.rb +54 -0
  22. data/lib/doc_fox/evidence_submission/facade.rb +20 -0
  23. data/lib/doc_fox/evidence_submission/get_service.rb +54 -0
  24. data/lib/doc_fox/evidence_submission/list_service.rb +36 -0
  25. data/lib/doc_fox/evidence_submission/reject_service.rb +58 -0
  26. data/lib/doc_fox/evidence_submission/replace_service.rb +54 -0
  27. data/lib/doc_fox/evidence_submission/update_service.rb +95 -0
  28. data/lib/doc_fox/kyc_application/approve_service.rb +2 -0
  29. data/lib/doc_fox/kyc_application/archive_service.rb +2 -0
  30. data/lib/doc_fox/kyc_application/create_service.rb +2 -0
  31. data/lib/doc_fox/kyc_application/delete_service.rb +2 -0
  32. data/lib/doc_fox/kyc_application/get_service.rb +5 -3
  33. data/lib/doc_fox/kyc_application/list_service.rb +2 -0
  34. data/lib/doc_fox/kyc_application/transfer_service.rb +2 -0
  35. data/lib/doc_fox/kyc_application/unapprove_service.rb +2 -0
  36. data/lib/doc_fox/kyc_application/unarchive_service.rb +2 -0
  37. data/lib/doc_fox/kyc_entity_template/get_service.rb +4 -2
  38. data/lib/doc_fox/kyc_entity_template/list_service.rb +2 -0
  39. data/lib/doc_fox/profile/facade.rb +15 -0
  40. data/lib/doc_fox/profile/get_service.rb +53 -0
  41. data/lib/doc_fox/profile/list_service.rb +36 -0
  42. data/lib/doc_fox/status_summary/facade.rb +14 -0
  43. data/lib/doc_fox/status_summary/get_service.rb +47 -0
  44. data/lib/doc_fox/user/get_service.rb +4 -2
  45. data/lib/doc_fox/user/list_service.rb +2 -0
  46. data/lib/doc_fox/version.rb +1 -1
  47. data/lib/doc_fox.rb +1 -0
  48. metadata +40 -2
@@ -0,0 +1,47 @@
1
+ # frozen_string_literal: true
2
+
3
+ class DocFox::StatusSummary::GetService < DocFox::BaseService
4
+ attr_reader :id
5
+
6
+ validates :id, presence: true
7
+
8
+ after_call :set_facade
9
+
10
+ delegate_missing_to :@facade
11
+
12
+ def initialize(id:)
13
+ @id = id
14
+ end
15
+
16
+ # Get a status summary of a KYC application.
17
+ #
18
+ # https://www.docfoxapp.com/api/v2/documentation#tag/Status-Summaries/paths/~1api~1v2~1kyc_applications~1%7Bkyc_application_id%7D~1status_summaries/get
19
+ #
20
+ # ==== Examples
21
+ #
22
+ # service = DocFox::StatusSummary::GetService.call(id: '')
23
+ #
24
+ # service.success? # => true
25
+ # service.errors # => #<ActiveModel::Errors []>
26
+ #
27
+ # service.response # => #<Faraday::Response ...>
28
+ # service.response.status # => 200
29
+ # service.response.body # => {}
30
+ #
31
+ # service.facade # => #<DocFox::StatusSummary::Facade ...>
32
+ # service.facade.id
33
+ # service.id
34
+ #
35
+ # service.relationships.dig('kyc_application', 'links', 'related')
36
+ #
37
+ # GET /api/v2/kyc_applications/:id/status_summaries
38
+ def call
39
+ connection.get("kyc_applications/#{id}/status_summaries")
40
+ end
41
+
42
+ private
43
+
44
+ def set_facade
45
+ @facade = DocFox::StatusSummary::Facade.new(response.body)
46
+ end
47
+ end
@@ -3,18 +3,20 @@
3
3
  class DocFox::User::GetService < DocFox::BaseService
4
4
  attr_reader :id
5
5
 
6
+ validates :id, presence: true
7
+
6
8
  after_call :set_facade
7
9
 
8
10
  delegate_missing_to :@facade
9
11
 
10
- validates :id, presence: true
11
-
12
12
  def initialize(id:)
13
13
  @id = id
14
14
  end
15
15
 
16
16
  # Get a user.
17
17
  #
18
+ # https://www.docfoxapp.com/api/v2/documentation#tag/Users/paths/~1api~1v2~1users~1%7Buser_id%7D/get
19
+ #
18
20
  # ==== Examples
19
21
  #
20
22
  # service = DocFox::User::GetService.call(id: '')
@@ -5,6 +5,8 @@ class DocFox::User::ListService < DocFox::BaseService
5
5
 
6
6
  # List users.
7
7
  #
8
+ # https://www.docfoxapp.com/api/v2/documentation#tag/Users/paths/~1api~1v2~1users/get
9
+ #
8
10
  # ==== Examples
9
11
  #
10
12
  # service = DocFox::User::ListService.call.first
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module DocFox
4
- VERSION = '0.1.1'
4
+ VERSION = '0.2.0'
5
5
  end
data/lib/doc_fox.rb CHANGED
@@ -3,6 +3,7 @@
3
3
  require 'active_call'
4
4
  require 'active_call/api'
5
5
  require 'active_support/core_ext/time'
6
+ require 'faraday/follow_redirects'
6
7
 
7
8
  loader = Zeitwerk::Loader.for_gem
8
9
  loader.ignore("#{__dir__}/active_call-doc_fox.rb")
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: active_call-doc_fox
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.1
4
+ version: 0.2.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Kobus Joubert
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2025-04-02 00:00:00.000000000 Z
11
+ date: 2025-04-15 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: active_call-api
@@ -24,6 +24,20 @@ dependencies:
24
24
  - - "~>"
25
25
  - !ruby/object:Gem::Version
26
26
  version: '0.1'
27
+ - !ruby/object:Gem::Dependency
28
+ name: faraday-follow_redirects
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '0.3'
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '0.3'
27
41
  - !ruby/object:Gem::Dependency
28
42
  name: openssl
29
43
  requirement: !ruby/object:Gem::Requirement
@@ -59,7 +73,26 @@ files:
59
73
  - lib/doc_fox/authentication/get_service.rb
60
74
  - lib/doc_fox/base_service.rb
61
75
  - lib/doc_fox/concerns/enumerable.rb
76
+ - lib/doc_fox/data_requirement/facade.rb
77
+ - lib/doc_fox/data_requirement/get_service.rb
78
+ - lib/doc_fox/data_requirement/list_service.rb
79
+ - lib/doc_fox/document/download_service.rb
80
+ - lib/doc_fox/document/facade.rb
81
+ - lib/doc_fox/document/get_service.rb
82
+ - lib/doc_fox/document/list_service.rb
83
+ - lib/doc_fox/document/upload_service.rb
84
+ - lib/doc_fox/document_token/create_service.rb
85
+ - lib/doc_fox/document_token/facade.rb
86
+ - lib/doc_fox/document_token/get_service.rb
87
+ - lib/doc_fox/document_token/list_service.rb
62
88
  - lib/doc_fox/error.rb
89
+ - lib/doc_fox/evidence_submission/approve_service.rb
90
+ - lib/doc_fox/evidence_submission/facade.rb
91
+ - lib/doc_fox/evidence_submission/get_service.rb
92
+ - lib/doc_fox/evidence_submission/list_service.rb
93
+ - lib/doc_fox/evidence_submission/reject_service.rb
94
+ - lib/doc_fox/evidence_submission/replace_service.rb
95
+ - lib/doc_fox/evidence_submission/update_service.rb
63
96
  - lib/doc_fox/kyc_application/approve_service.rb
64
97
  - lib/doc_fox/kyc_application/archive_service.rb
65
98
  - lib/doc_fox/kyc_application/create_service.rb
@@ -73,6 +106,11 @@ files:
73
106
  - lib/doc_fox/kyc_entity_template/facade.rb
74
107
  - lib/doc_fox/kyc_entity_template/get_service.rb
75
108
  - lib/doc_fox/kyc_entity_template/list_service.rb
109
+ - lib/doc_fox/profile/facade.rb
110
+ - lib/doc_fox/profile/get_service.rb
111
+ - lib/doc_fox/profile/list_service.rb
112
+ - lib/doc_fox/status_summary/facade.rb
113
+ - lib/doc_fox/status_summary/get_service.rb
76
114
  - lib/doc_fox/user/facade.rb
77
115
  - lib/doc_fox/user/get_service.rb
78
116
  - lib/doc_fox/user/list_service.rb