marble_api_client 1.0.0.pre.alpha

Sign up to get free protection for your applications and to get access to all the features.
Files changed (52) hide show
  1. checksums.yaml +7 -0
  2. data/.editorconfig +8 -0
  3. data/.gitignore +6 -0
  4. data/.rubocop.yml +25 -0
  5. data/.ruby-version +1 -0
  6. data/.travis.yml +25 -0
  7. data/CHANGELOG.md +3 -0
  8. data/CODE_OF_CONDUCT.md +74 -0
  9. data/Gemfile +5 -0
  10. data/Guardfile +16 -0
  11. data/LICENSE +7 -0
  12. data/README.md +137 -0
  13. data/Rakefile +17 -0
  14. data/bin/console +18 -0
  15. data/lib/marble_api_client/proxy.rb +68 -0
  16. data/lib/marble_api_client/requests/create.rb +27 -0
  17. data/lib/marble_api_client/requests/index.rb +31 -0
  18. data/lib/marble_api_client/requests.rb +4 -0
  19. data/lib/marble_api_client/responses/bad_request.rb +25 -0
  20. data/lib/marble_api_client/responses/client_error.rb +21 -0
  21. data/lib/marble_api_client/responses/forbidden.rb +29 -0
  22. data/lib/marble_api_client/responses/http_methods.rb +29 -0
  23. data/lib/marble_api_client/responses/list.rb +60 -0
  24. data/lib/marble_api_client/responses/not_found.rb +25 -0
  25. data/lib/marble_api_client/responses/not_implemented.rb +24 -0
  26. data/lib/marble_api_client/responses/record.rb +25 -0
  27. data/lib/marble_api_client/responses/server_error.rb +27 -0
  28. data/lib/marble_api_client/responses/success.rb +21 -0
  29. data/lib/marble_api_client/responses/unauthorized.rb +19 -0
  30. data/lib/marble_api_client/responses/unprocessable_entity.rb +40 -0
  31. data/lib/marble_api_client/responses.rb +92 -0
  32. data/lib/marble_api_client/version.rb +12 -0
  33. data/lib/marble_api_client.rb +18 -0
  34. data/marble_api_client.gemspec +32 -0
  35. data/spec/marble_api_client/proxy_spec.rb +89 -0
  36. data/spec/marble_api_client/requests/create_spec.rb +30 -0
  37. data/spec/marble_api_client/requests/index_spec.rb +34 -0
  38. data/spec/marble_api_client/responses/bad_request_spec.rb +24 -0
  39. data/spec/marble_api_client/responses/client_error_spec.rb +21 -0
  40. data/spec/marble_api_client/responses/forbidden_spec.rb +31 -0
  41. data/spec/marble_api_client/responses/list_spec.rb +77 -0
  42. data/spec/marble_api_client/responses/not_found_spec.rb +24 -0
  43. data/spec/marble_api_client/responses/not_implmented_spec.rb +24 -0
  44. data/spec/marble_api_client/responses/record_spec.rb +24 -0
  45. data/spec/marble_api_client/responses/responses_spec.rb +90 -0
  46. data/spec/marble_api_client/responses/server_error_spec.rb +24 -0
  47. data/spec/marble_api_client/responses/success_spec.rb +13 -0
  48. data/spec/marble_api_client/responses/unauthorized_spec.rb +13 -0
  49. data/spec/marble_api_client/responses/unprocessable_entity_spec.rb +49 -0
  50. data/spec/marble_api_client_spec.rb +16 -0
  51. data/spec/spec_helper.rb +23 -0
  52. metadata +223 -0
@@ -0,0 +1,90 @@
1
+ # frozen_string_literal: true
2
+
3
+ #
4
+ # Copyright (c) 2019-present, Blue Marble Payroll, LLC
5
+ #
6
+ # This source code is licensed under the MIT license found in the
7
+ # LICENSE file in the root directory of this source tree.
8
+ #
9
+
10
+ require 'spec_helper'
11
+
12
+ RSpec.describe MarbleApiClient::Responses do
13
+ it 'requires a HTTPResponse' do
14
+ response = nil
15
+ expect { described_class.get_response_object(response, 'index') }
16
+ .to raise_error(ArgumentError)
17
+ end
18
+
19
+ context 'returns the right objects' do
20
+ it '200' do
21
+ response = Net::HTTPResponse.new(1.0, '200', 'OK')
22
+ response.uri = 'www.exampleuri.com/index'
23
+ expect(described_class.get_response_object(response, 'index'))
24
+ .to be_a_kind_of(MarbleApiClient::Responses::Success)
25
+ end
26
+
27
+ it '200 Index' do
28
+ response = Net::HTTPResponse.new(1.0, '200', 'OK')
29
+ response.uri = 'www.exampleuri.com/index'
30
+ expect(described_class.get_response_object(response, 'index'))
31
+ .to be_a_kind_of(MarbleApiClient::Responses::List)
32
+ end
33
+
34
+ it '200 Create' do
35
+ response = Net::HTTPResponse.new(1.0, '200', 'OK')
36
+ response.uri = 'www.exampleuri.com/create'
37
+ expect(described_class.get_response_object(response, 'create'))
38
+ .to be_a_kind_of(MarbleApiClient::Responses::Record)
39
+ end
40
+
41
+ it '400' do
42
+ response = Net::HTTPResponse.new(1.0, '400', 'Client Error')
43
+ response.uri = 'www.exampleuri.com/index'
44
+ expect(described_class.get_response_object(response, 'index'))
45
+ .to be_a_kind_of(MarbleApiClient::Responses::BadRequest)
46
+ end
47
+
48
+ it '401' do
49
+ response = Net::HTTPResponse.new(1.0, '401', 'Client Error')
50
+ response.uri = 'www.exampleuri.com/index'
51
+ expect(described_class.get_response_object(response, 'index'))
52
+ .to be_a_kind_of(MarbleApiClient::Responses::Unauthorized)
53
+ end
54
+
55
+ it '403' do
56
+ response = Net::HTTPResponse.new(1.0, '403', 'Client Error')
57
+ response.uri = 'www.exampleuri.com/index'
58
+ expect(described_class.get_response_object(response, 'index'))
59
+ .to be_a_kind_of(MarbleApiClient::Responses::Forbidden)
60
+ end
61
+
62
+ it '404' do
63
+ response = Net::HTTPResponse.new(1.0, '404', 'Client Error')
64
+ response.uri = 'www.exampleuri.com/index'
65
+ expect(described_class.get_response_object(response, 'index'))
66
+ .to be_a_kind_of(MarbleApiClient::Responses::NotFound)
67
+ end
68
+
69
+ it '422' do
70
+ response = Net::HTTPResponse.new(1.0, '422', 'Client Error')
71
+ response.uri = 'www.exampleuri.com/index'
72
+ expect(described_class.get_response_object(response, 'index'))
73
+ .to be_a_kind_of(MarbleApiClient::Responses::UnprocessableEntity)
74
+ end
75
+
76
+ it '500' do
77
+ response = Net::HTTPResponse.new(1.0, '500', 'Server Error')
78
+ response.uri = 'www.exampleuri.com/index'
79
+ expect(described_class.get_response_object(response, 'index'))
80
+ .to be_a_kind_of(MarbleApiClient::Responses::ServerError)
81
+ end
82
+
83
+ it '501' do
84
+ response = Net::HTTPResponse.new(1.0, '501', 'Server Error')
85
+ response.uri = 'www.exampleuri.com/index'
86
+ expect(described_class.get_response_object(response, 'index'))
87
+ .to be_a_kind_of(MarbleApiClient::Responses::NotImplemented)
88
+ end
89
+ end
90
+ end
@@ -0,0 +1,24 @@
1
+ # frozen_string_literal: true
2
+
3
+ #
4
+ # Copyright (c) 2019-present, Blue Marble Payroll, LLC
5
+ #
6
+ # This source code is licensed under the MIT license found in the
7
+ # LICENSE file in the root directory of this source tree.
8
+ #
9
+
10
+ require 'spec_helper'
11
+
12
+ RSpec.describe MarbleApiClient::Responses::ServerError do
13
+ context 'provides' do
14
+ let(:error_hash) { { name: 'invalid' }.to_json }
15
+ let(:response) do
16
+ instance_double(Net::HTTPResponse, code: 400, body: { errors: error_hash }.to_json)
17
+ end
18
+
19
+ it 'errors' do
20
+ expect(described_class.new(response).errors)
21
+ .to eq(error_hash)
22
+ end
23
+ end
24
+ end
@@ -0,0 +1,13 @@
1
+ # frozen_string_literal: true
2
+
3
+ #
4
+ # Copyright (c) 2019-present, Blue Marble Payroll, LLC
5
+ #
6
+ # This source code is licensed under the MIT license found in the
7
+ # LICENSE file in the root directory of this source tree.
8
+ #
9
+
10
+ require 'spec_helper'
11
+
12
+ RSpec.describe MarbleApiClient::Responses::Success do
13
+ end
@@ -0,0 +1,13 @@
1
+ # frozen_string_literal: true
2
+
3
+ #
4
+ # Copyright (c) 2019-present, Blue Marble Payroll, LLC
5
+ #
6
+ # This source code is licensed under the MIT license found in the
7
+ # LICENSE file in the root directory of this source tree.
8
+ #
9
+
10
+ require 'spec_helper'
11
+
12
+ RSpec.describe MarbleApiClient::Responses::Unauthorized do
13
+ end
@@ -0,0 +1,49 @@
1
+ # frozen_string_literal: true
2
+
3
+ #
4
+ # Copyright (c) 2019-present, Blue Marble Payroll, LLC
5
+ #
6
+ # This source code is licensed under the MIT license found in the
7
+ # LICENSE file in the root directory of this source tree.
8
+ #
9
+
10
+ require 'spec_helper'
11
+
12
+ RSpec.describe MarbleApiClient::Responses::UnprocessableEntity do
13
+ context 'provides' do
14
+ let(:errors) { [{ name: 'invalid' }].to_json }
15
+ let(:error_properties) { %w[property_1 property_2].to_json }
16
+ let(:warnings) { [{ name: 'warning' }].to_json }
17
+ let(:warning_properties) { %w[property_3 property_4].to_json }
18
+ let(:response) do
19
+ instance_double(Net::HTTPResponse,
20
+ code: 400,
21
+ body: {
22
+ errors: errors,
23
+ errorProperties: error_properties,
24
+ warnings: warnings,
25
+ warningProperties: warning_properties
26
+ }.to_json)
27
+ end
28
+
29
+ it 'errors' do
30
+ expect(described_class.new(response).errors)
31
+ .to eq(errors)
32
+ end
33
+
34
+ it 'error properties' do
35
+ expect(described_class.new(response).error_properties)
36
+ .to eq(error_properties)
37
+ end
38
+
39
+ it 'warnings' do
40
+ expect(described_class.new(response).warnings)
41
+ .to eq(warnings)
42
+ end
43
+
44
+ it 'warning properties' do
45
+ expect(described_class.new(response).warning_properties)
46
+ .to eq(warning_properties)
47
+ end
48
+ end
49
+ end
@@ -0,0 +1,16 @@
1
+ # frozen_string_literal: true
2
+
3
+ #
4
+ # Copyright (c) 2019-present, Blue Marble Payroll, LLC
5
+ #
6
+ # This source code is licensed under the MIT license found in the
7
+ # LICENSE file in the root directory of this source tree.
8
+ #
9
+
10
+ require 'spec_helper'
11
+
12
+ RSpec.describe MarbleApiClient do
13
+ it 'has a version number' do
14
+ expect(MarbleApiClient::VERSION).not_to be nil
15
+ end
16
+ end
@@ -0,0 +1,23 @@
1
+ # frozen_string_literal: true
2
+
3
+ #
4
+ # Copyright (c) 2018-present, Blue Marble Payroll, LLC
5
+ #
6
+ # This source code is licensed under the MIT license found in the
7
+ # LICENSE file in the root directory of this source tree.
8
+ #
9
+
10
+ require 'pry'
11
+ require 'webmock/rspec'
12
+
13
+ unless ENV['DISABLE_SIMPLECOV'] == 'true'
14
+ require 'simplecov'
15
+ require 'simplecov-console'
16
+
17
+ SimpleCov.formatter = SimpleCov::Formatter::Console
18
+ SimpleCov.start do
19
+ add_filter %r{\A/spec/}
20
+ end
21
+ end
22
+
23
+ require './lib/marble_api_client'
metadata ADDED
@@ -0,0 +1,223 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: marble_api_client
3
+ version: !ruby/object:Gem::Version
4
+ version: 1.0.0.pre.alpha
5
+ platform: ruby
6
+ authors:
7
+ - Dan Dewar
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2019-12-12 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: guard-rspec
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '4.7'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '4.7'
27
+ - !ruby/object:Gem::Dependency
28
+ name: pry
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rake
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '12'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '12'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rspec
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - ">="
60
+ - !ruby/object:Gem::Version
61
+ version: '0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: '0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: rubocop
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: 0.74.0
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: 0.74.0
83
+ - !ruby/object:Gem::Dependency
84
+ name: simplecov
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - "~>"
88
+ - !ruby/object:Gem::Version
89
+ version: 0.17.0
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - "~>"
95
+ - !ruby/object:Gem::Version
96
+ version: 0.17.0
97
+ - !ruby/object:Gem::Dependency
98
+ name: simplecov-console
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - "~>"
102
+ - !ruby/object:Gem::Version
103
+ version: 0.5.0
104
+ type: :development
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - "~>"
109
+ - !ruby/object:Gem::Version
110
+ version: 0.5.0
111
+ - !ruby/object:Gem::Dependency
112
+ name: webmock
113
+ requirement: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - ">="
116
+ - !ruby/object:Gem::Version
117
+ version: '0'
118
+ type: :development
119
+ prerelease: false
120
+ version_requirements: !ruby/object:Gem::Requirement
121
+ requirements:
122
+ - - ">="
123
+ - !ruby/object:Gem::Version
124
+ version: '0'
125
+ description: " Write a description.\n"
126
+ email:
127
+ - ddewar@bluemarblepayroll.com
128
+ executables:
129
+ - console
130
+ extensions: []
131
+ extra_rdoc_files: []
132
+ files:
133
+ - ".editorconfig"
134
+ - ".gitignore"
135
+ - ".rubocop.yml"
136
+ - ".ruby-version"
137
+ - ".travis.yml"
138
+ - CHANGELOG.md
139
+ - CODE_OF_CONDUCT.md
140
+ - Gemfile
141
+ - Guardfile
142
+ - LICENSE
143
+ - README.md
144
+ - Rakefile
145
+ - bin/console
146
+ - lib/marble_api_client.rb
147
+ - lib/marble_api_client/proxy.rb
148
+ - lib/marble_api_client/requests.rb
149
+ - lib/marble_api_client/requests/create.rb
150
+ - lib/marble_api_client/requests/index.rb
151
+ - lib/marble_api_client/responses.rb
152
+ - lib/marble_api_client/responses/bad_request.rb
153
+ - lib/marble_api_client/responses/client_error.rb
154
+ - lib/marble_api_client/responses/forbidden.rb
155
+ - lib/marble_api_client/responses/http_methods.rb
156
+ - lib/marble_api_client/responses/list.rb
157
+ - lib/marble_api_client/responses/not_found.rb
158
+ - lib/marble_api_client/responses/not_implemented.rb
159
+ - lib/marble_api_client/responses/record.rb
160
+ - lib/marble_api_client/responses/server_error.rb
161
+ - lib/marble_api_client/responses/success.rb
162
+ - lib/marble_api_client/responses/unauthorized.rb
163
+ - lib/marble_api_client/responses/unprocessable_entity.rb
164
+ - lib/marble_api_client/version.rb
165
+ - marble_api_client.gemspec
166
+ - spec/marble_api_client/proxy_spec.rb
167
+ - spec/marble_api_client/requests/create_spec.rb
168
+ - spec/marble_api_client/requests/index_spec.rb
169
+ - spec/marble_api_client/responses/bad_request_spec.rb
170
+ - spec/marble_api_client/responses/client_error_spec.rb
171
+ - spec/marble_api_client/responses/forbidden_spec.rb
172
+ - spec/marble_api_client/responses/list_spec.rb
173
+ - spec/marble_api_client/responses/not_found_spec.rb
174
+ - spec/marble_api_client/responses/not_implmented_spec.rb
175
+ - spec/marble_api_client/responses/record_spec.rb
176
+ - spec/marble_api_client/responses/responses_spec.rb
177
+ - spec/marble_api_client/responses/server_error_spec.rb
178
+ - spec/marble_api_client/responses/success_spec.rb
179
+ - spec/marble_api_client/responses/unauthorized_spec.rb
180
+ - spec/marble_api_client/responses/unprocessable_entity_spec.rb
181
+ - spec/marble_api_client_spec.rb
182
+ - spec/spec_helper.rb
183
+ homepage: https://github.com/bluemarblepayroll/marble_api_client
184
+ licenses:
185
+ - MIT
186
+ metadata: {}
187
+ post_install_message:
188
+ rdoc_options: []
189
+ require_paths:
190
+ - lib
191
+ required_ruby_version: !ruby/object:Gem::Requirement
192
+ requirements:
193
+ - - ">="
194
+ - !ruby/object:Gem::Version
195
+ version: 2.3.8
196
+ required_rubygems_version: !ruby/object:Gem::Requirement
197
+ requirements:
198
+ - - ">"
199
+ - !ruby/object:Gem::Version
200
+ version: 1.3.1
201
+ requirements: []
202
+ rubygems_version: 3.0.3
203
+ signing_key:
204
+ specification_version: 4
205
+ summary: Write a summary.
206
+ test_files:
207
+ - spec/marble_api_client/proxy_spec.rb
208
+ - spec/marble_api_client/requests/create_spec.rb
209
+ - spec/marble_api_client/requests/index_spec.rb
210
+ - spec/marble_api_client/responses/bad_request_spec.rb
211
+ - spec/marble_api_client/responses/client_error_spec.rb
212
+ - spec/marble_api_client/responses/forbidden_spec.rb
213
+ - spec/marble_api_client/responses/list_spec.rb
214
+ - spec/marble_api_client/responses/not_found_spec.rb
215
+ - spec/marble_api_client/responses/not_implmented_spec.rb
216
+ - spec/marble_api_client/responses/record_spec.rb
217
+ - spec/marble_api_client/responses/responses_spec.rb
218
+ - spec/marble_api_client/responses/server_error_spec.rb
219
+ - spec/marble_api_client/responses/success_spec.rb
220
+ - spec/marble_api_client/responses/unauthorized_spec.rb
221
+ - spec/marble_api_client/responses/unprocessable_entity_spec.rb
222
+ - spec/marble_api_client_spec.rb
223
+ - spec/spec_helper.rb