frodo 0.10.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.
- checksums.yaml +7 -0
- data/.autotest +2 -0
- data/.circleci/config.yml +54 -0
- data/.gitignore +24 -0
- data/.gitlab-ci.yml +9 -0
- data/.rspec +2 -0
- data/.ruby-gemset +1 -0
- data/.ruby-version +1 -0
- data/.travis.yml +75 -0
- data/CHANGELOG.md +163 -0
- data/Gemfile +4 -0
- data/LICENSE.txt +23 -0
- data/README.md +479 -0
- data/Rakefile +7 -0
- data/TODO.md +55 -0
- data/frodo.gemspec +39 -0
- data/images/frodo.jpg +0 -0
- data/lib/frodo/abstract_client.rb +11 -0
- data/lib/frodo/client.rb +6 -0
- data/lib/frodo/concerns/api.rb +292 -0
- data/lib/frodo/concerns/authentication.rb +32 -0
- data/lib/frodo/concerns/base.rb +84 -0
- data/lib/frodo/concerns/caching.rb +26 -0
- data/lib/frodo/concerns/connection.rb +79 -0
- data/lib/frodo/concerns/verbs.rb +68 -0
- data/lib/frodo/config.rb +143 -0
- data/lib/frodo/entity.rb +335 -0
- data/lib/frodo/entity_container.rb +75 -0
- data/lib/frodo/entity_set.rb +131 -0
- data/lib/frodo/errors.rb +70 -0
- data/lib/frodo/middleware/authentication/token.rb +13 -0
- data/lib/frodo/middleware/authentication.rb +87 -0
- data/lib/frodo/middleware/authorization.rb +18 -0
- data/lib/frodo/middleware/caching.rb +30 -0
- data/lib/frodo/middleware/custom_headers.rb +14 -0
- data/lib/frodo/middleware/gzip.rb +33 -0
- data/lib/frodo/middleware/instance_url.rb +20 -0
- data/lib/frodo/middleware/logger.rb +42 -0
- data/lib/frodo/middleware/multipart.rb +64 -0
- data/lib/frodo/middleware/odata_headers.rb +13 -0
- data/lib/frodo/middleware/raise_error.rb +47 -0
- data/lib/frodo/middleware.rb +33 -0
- data/lib/frodo/navigation_property/proxy.rb +80 -0
- data/lib/frodo/navigation_property.rb +29 -0
- data/lib/frodo/properties/binary.rb +50 -0
- data/lib/frodo/properties/boolean.rb +37 -0
- data/lib/frodo/properties/collection.rb +50 -0
- data/lib/frodo/properties/complex.rb +114 -0
- data/lib/frodo/properties/date.rb +27 -0
- data/lib/frodo/properties/date_time.rb +83 -0
- data/lib/frodo/properties/date_time_offset.rb +17 -0
- data/lib/frodo/properties/decimal.rb +54 -0
- data/lib/frodo/properties/enum.rb +62 -0
- data/lib/frodo/properties/float.rb +67 -0
- data/lib/frodo/properties/geography/base.rb +162 -0
- data/lib/frodo/properties/geography/line_string.rb +33 -0
- data/lib/frodo/properties/geography/point.rb +31 -0
- data/lib/frodo/properties/geography/polygon.rb +38 -0
- data/lib/frodo/properties/geography.rb +13 -0
- data/lib/frodo/properties/guid.rb +17 -0
- data/lib/frodo/properties/integer.rb +107 -0
- data/lib/frodo/properties/number.rb +14 -0
- data/lib/frodo/properties/string.rb +72 -0
- data/lib/frodo/properties/time.rb +40 -0
- data/lib/frodo/properties/time_of_day.rb +27 -0
- data/lib/frodo/properties.rb +32 -0
- data/lib/frodo/property.rb +139 -0
- data/lib/frodo/property_registry.rb +41 -0
- data/lib/frodo/query/criteria/comparison_operators.rb +49 -0
- data/lib/frodo/query/criteria/date_functions.rb +61 -0
- data/lib/frodo/query/criteria/geography_functions.rb +21 -0
- data/lib/frodo/query/criteria/lambda_operators.rb +27 -0
- data/lib/frodo/query/criteria/string_functions.rb +40 -0
- data/lib/frodo/query/criteria.rb +92 -0
- data/lib/frodo/query/in_batches.rb +58 -0
- data/lib/frodo/query.rb +221 -0
- data/lib/frodo/railtie.rb +19 -0
- data/lib/frodo/schema/complex_type.rb +79 -0
- data/lib/frodo/schema/enum_type.rb +95 -0
- data/lib/frodo/schema.rb +164 -0
- data/lib/frodo/service.rb +199 -0
- data/lib/frodo/service_registry.rb +52 -0
- data/lib/frodo/version.rb +3 -0
- data/lib/frodo.rb +67 -0
- data/spec/fixtures/auth_success_response.json +11 -0
- data/spec/fixtures/error.json +11 -0
- data/spec/fixtures/files/entity_to_xml.xml +18 -0
- data/spec/fixtures/files/error.xml +5 -0
- data/spec/fixtures/files/metadata.xml +150 -0
- data/spec/fixtures/files/metadata_with_error.xml +157 -0
- data/spec/fixtures/files/product_0.json +10 -0
- data/spec/fixtures/files/product_0.xml +28 -0
- data/spec/fixtures/files/products.json +106 -0
- data/spec/fixtures/files/products.xml +308 -0
- data/spec/fixtures/files/supplier_0.json +26 -0
- data/spec/fixtures/files/supplier_0.xml +32 -0
- data/spec/fixtures/leads.json +923 -0
- data/spec/fixtures/refresh_error_response.json +8 -0
- data/spec/frodo/abstract_client_spec.rb +13 -0
- data/spec/frodo/client_spec.rb +57 -0
- data/spec/frodo/concerns/authentication_spec.rb +79 -0
- data/spec/frodo/concerns/base_spec.rb +68 -0
- data/spec/frodo/concerns/caching_spec.rb +40 -0
- data/spec/frodo/concerns/connection_spec.rb +65 -0
- data/spec/frodo/config_spec.rb +127 -0
- data/spec/frodo/entity/shared_examples.rb +83 -0
- data/spec/frodo/entity_container_spec.rb +38 -0
- data/spec/frodo/entity_set_spec.rb +169 -0
- data/spec/frodo/entity_spec.rb +153 -0
- data/spec/frodo/errors_spec.rb +48 -0
- data/spec/frodo/middleware/authentication/token_spec.rb +87 -0
- data/spec/frodo/middleware/authentication_spec.rb +83 -0
- data/spec/frodo/middleware/authorization_spec.rb +17 -0
- data/spec/frodo/middleware/custom_headers_spec.rb +21 -0
- data/spec/frodo/middleware/gzip_spec.rb +68 -0
- data/spec/frodo/middleware/instance_url_spec.rb +27 -0
- data/spec/frodo/middleware/logger_spec.rb +21 -0
- data/spec/frodo/middleware/odata_headers_spec.rb +15 -0
- data/spec/frodo/middleware/raise_error_spec.rb +66 -0
- data/spec/frodo/navigation_property/proxy_spec.rb +46 -0
- data/spec/frodo/navigation_property_spec.rb +55 -0
- data/spec/frodo/properties/binary_spec.rb +50 -0
- data/spec/frodo/properties/boolean_spec.rb +72 -0
- data/spec/frodo/properties/collection_spec.rb +44 -0
- data/spec/frodo/properties/date_spec.rb +23 -0
- data/spec/frodo/properties/date_time_offset_spec.rb +30 -0
- data/spec/frodo/properties/date_time_spec.rb +23 -0
- data/spec/frodo/properties/decimal_spec.rb +50 -0
- data/spec/frodo/properties/float_spec.rb +45 -0
- data/spec/frodo/properties/geography/line_string_spec.rb +33 -0
- data/spec/frodo/properties/geography/point_spec.rb +29 -0
- data/spec/frodo/properties/geography/polygon_spec.rb +55 -0
- data/spec/frodo/properties/geography/shared_examples.rb +72 -0
- data/spec/frodo/properties/guid_spec.rb +17 -0
- data/spec/frodo/properties/integer_spec.rb +58 -0
- data/spec/frodo/properties/string_spec.rb +46 -0
- data/spec/frodo/properties/time_of_day_spec.rb +23 -0
- data/spec/frodo/properties/time_spec.rb +15 -0
- data/spec/frodo/property_registry_spec.rb +16 -0
- data/spec/frodo/property_spec.rb +71 -0
- data/spec/frodo/query/criteria_spec.rb +229 -0
- data/spec/frodo/query_spec.rb +156 -0
- data/spec/frodo/schema/complex_type_spec.rb +97 -0
- data/spec/frodo/schema/enum_type_spec.rb +112 -0
- data/spec/frodo/schema_spec.rb +113 -0
- data/spec/frodo/service_registry_spec.rb +19 -0
- data/spec/frodo/service_spec.rb +153 -0
- data/spec/frodo/usage_example_spec.rb +161 -0
- data/spec/spec_helper.rb +35 -0
- data/spec/support/coverage.rb +2 -0
- data/spec/support/fixture_helpers.rb +14 -0
- data/spec/support/middleware.rb +19 -0
- metadata +479 -0
|
@@ -0,0 +1,161 @@
|
|
|
1
|
+
require 'spec_helper'
|
|
2
|
+
|
|
3
|
+
describe 'Usage examples', vcr: { cassette_name: 'usage_example_specs' } do
|
|
4
|
+
let(:service_url) { 'http://services.odata.org/V4/OData/OData.svc' }
|
|
5
|
+
let(:service) { Frodo::Service.new(service_url, name: 'ODataDemo', metadata_file: metadata_file) }
|
|
6
|
+
let(:metadata_file) { 'spec/fixtures/files/metadata.xml' }
|
|
7
|
+
|
|
8
|
+
describe 'getting information' do
|
|
9
|
+
it 'returns the service URL' do
|
|
10
|
+
expect(service.service_url).to eq(service_url)
|
|
11
|
+
end
|
|
12
|
+
|
|
13
|
+
it 'returns the service namespace' do
|
|
14
|
+
expect(service.namespace).to eq('ODataDemo')
|
|
15
|
+
end
|
|
16
|
+
|
|
17
|
+
it 'lists entity types' do
|
|
18
|
+
expect(service.entity_types).to eq(%w[
|
|
19
|
+
ODataDemo.Product
|
|
20
|
+
ODataDemo.FeaturedProduct
|
|
21
|
+
ODataDemo.ProductDetail
|
|
22
|
+
ODataDemo.Category
|
|
23
|
+
ODataDemo.Supplier
|
|
24
|
+
ODataDemo.Person
|
|
25
|
+
ODataDemo.Customer
|
|
26
|
+
ODataDemo.Employee
|
|
27
|
+
ODataDemo.PersonDetail
|
|
28
|
+
ODataDemo.Advertisement
|
|
29
|
+
])
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
it 'lists entity sets' do
|
|
33
|
+
expect(service.entity_sets).to eq({
|
|
34
|
+
"Products" => "ODataDemo.Product",
|
|
35
|
+
"ProductDetails" => "ODataDemo.ProductDetail",
|
|
36
|
+
"Categories" => "ODataDemo.Category",
|
|
37
|
+
"Suppliers" => "ODataDemo.Supplier",
|
|
38
|
+
"Persons" => "ODataDemo.Person",
|
|
39
|
+
"PersonDetails" => "ODataDemo.PersonDetail",
|
|
40
|
+
"Advertisements" => "ODataDemo.Advertisement"
|
|
41
|
+
})
|
|
42
|
+
end
|
|
43
|
+
end
|
|
44
|
+
|
|
45
|
+
describe 'working with entity sets' do
|
|
46
|
+
# it 'accessing entity sets' do
|
|
47
|
+
# service.entity_sets.each do |entity_set_name, entity_name|
|
|
48
|
+
# entity_set = service[entity_set_name]
|
|
49
|
+
|
|
50
|
+
# expect(entity_set).to be_a(Frodo::EntitySet)
|
|
51
|
+
# expect(entity_set.name).to eq(entity_set_name)
|
|
52
|
+
# expect(entity_set.type).to eq(entity_name)
|
|
53
|
+
# expect(entity_set.namespace).to eq(service.namespace)
|
|
54
|
+
# end
|
|
55
|
+
# end
|
|
56
|
+
|
|
57
|
+
# describe 'accessing entities' do
|
|
58
|
+
# let(:products) { service['Products'] }
|
|
59
|
+
|
|
60
|
+
# it 'getting the first entity in a set' do
|
|
61
|
+
# expect(products.first).to be_a(Frodo::Entity)
|
|
62
|
+
# expect(products.first.name).to eq('Product')
|
|
63
|
+
# end
|
|
64
|
+
|
|
65
|
+
# it 'iterating over the entire set' do
|
|
66
|
+
# products.each do |product|
|
|
67
|
+
# expect(product).to be_a(Frodo::Entity)
|
|
68
|
+
# expect(product.name).to eq('Product')
|
|
69
|
+
# end
|
|
70
|
+
# end
|
|
71
|
+
|
|
72
|
+
# it 'counting entities' do
|
|
73
|
+
# expect(products.count).to eq(11)
|
|
74
|
+
# end
|
|
75
|
+
|
|
76
|
+
# it 'creating a new entity' do
|
|
77
|
+
# new_product = products.new_entity
|
|
78
|
+
|
|
79
|
+
# expect(new_product).to be_a(Frodo::Entity)
|
|
80
|
+
# expect(new_product.name).to eq('Product')
|
|
81
|
+
# end
|
|
82
|
+
# end
|
|
83
|
+
|
|
84
|
+
# describe 'querying' do
|
|
85
|
+
# let(:products) { service['Products'] }
|
|
86
|
+
# let(:query) { products.query }
|
|
87
|
+
|
|
88
|
+
# it 'obtain a query object using #query' do
|
|
89
|
+
# expect(products.query).to be_a(Frodo::Query)
|
|
90
|
+
# end
|
|
91
|
+
|
|
92
|
+
# it 'executing query' do
|
|
93
|
+
# results = query.execute
|
|
94
|
+
|
|
95
|
+
# expect(results.map { |p| p['Name']}).to eq([
|
|
96
|
+
# "Bread",
|
|
97
|
+
# "Milk",
|
|
98
|
+
# "Vint soda",
|
|
99
|
+
# "Havina Cola",
|
|
100
|
+
# "Fruit Punch",
|
|
101
|
+
# "Cranberry Juice",
|
|
102
|
+
# "Pink Lemonade",
|
|
103
|
+
# "DVD Player",
|
|
104
|
+
# "LCD HDTV",
|
|
105
|
+
# "Lemonade",
|
|
106
|
+
# "Coffee"
|
|
107
|
+
# ])
|
|
108
|
+
# end
|
|
109
|
+
|
|
110
|
+
# it 'adding criteria' do
|
|
111
|
+
# query.where(query['Name'].eq('Milk'))
|
|
112
|
+
# results = query.execute
|
|
113
|
+
|
|
114
|
+
# expect(query.to_s).to eq("Products?$filter=Name eq 'Milk'")
|
|
115
|
+
# results.each do |product|
|
|
116
|
+
# expect(product).to be_a(Frodo::Entity)
|
|
117
|
+
# expect(product.name).to eq('Product')
|
|
118
|
+
# expect(product['Name']).to eq('Milk')
|
|
119
|
+
# end
|
|
120
|
+
# end
|
|
121
|
+
|
|
122
|
+
# it 'ordering results' do
|
|
123
|
+
# results = query.order_by('Name').execute
|
|
124
|
+
|
|
125
|
+
# expect(results.map { |p| p['Name'] }).to eq([
|
|
126
|
+
# "Bread",
|
|
127
|
+
# "Coffee",
|
|
128
|
+
# "Cranberry Juice",
|
|
129
|
+
# "DVD Player",
|
|
130
|
+
# "Fruit Punch",
|
|
131
|
+
# "Havina Cola",
|
|
132
|
+
# "LCD HDTV",
|
|
133
|
+
# "Lemonade",
|
|
134
|
+
# "Milk",
|
|
135
|
+
# "Pink Lemonade",
|
|
136
|
+
# "Vint soda"
|
|
137
|
+
# ])
|
|
138
|
+
# end
|
|
139
|
+
# end
|
|
140
|
+
end
|
|
141
|
+
|
|
142
|
+
describe 'working with entities' do
|
|
143
|
+
# let(:product) { service['Products'][1] }
|
|
144
|
+
|
|
145
|
+
# it 'getting a list of property names' do
|
|
146
|
+
# expect(product.property_names).to eq([
|
|
147
|
+
# "ID", "Name", "Description", "ReleaseDate", "DiscontinuedDate", "Rating", "Price"
|
|
148
|
+
# ])
|
|
149
|
+
# end
|
|
150
|
+
|
|
151
|
+
# it 'accessing entity properties' do
|
|
152
|
+
# expect(product["ID"]).to eq(1)
|
|
153
|
+
# expect(product["Name"]).to eq("Milk")
|
|
154
|
+
# expect(product["Description"]).to eq("Low fat milk")
|
|
155
|
+
# expect(product["ReleaseDate"]).to eq(DateTime.parse("1995-10-01T00:00:00Z"))
|
|
156
|
+
# expect(product["DiscontinuedDate"]).to be_nil
|
|
157
|
+
# expect(product["Rating"]).to eq(3)
|
|
158
|
+
# expect(product["Price"]).to eq(3.5)
|
|
159
|
+
# end
|
|
160
|
+
end
|
|
161
|
+
end
|
data/spec/spec_helper.rb
ADDED
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
require 'frodo'
|
|
2
|
+
require 'rspec/matchers' # required for 'equivalent-xml'
|
|
3
|
+
require 'equivalent-xml'
|
|
4
|
+
require 'securerandom'
|
|
5
|
+
require 'timecop'
|
|
6
|
+
require 'webmock/rspec'
|
|
7
|
+
|
|
8
|
+
# Load all files from `spec/support`
|
|
9
|
+
Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each {|f| require f }
|
|
10
|
+
|
|
11
|
+
WebMock.disable_net_connect!
|
|
12
|
+
|
|
13
|
+
RSpec.configure do |config|
|
|
14
|
+
if config.files_to_run.one?
|
|
15
|
+
config.default_formatter = 'doc'
|
|
16
|
+
end
|
|
17
|
+
|
|
18
|
+
config.profile_examples = 3
|
|
19
|
+
config.order = :random
|
|
20
|
+
|
|
21
|
+
config.expect_with :rspec do |expectations|
|
|
22
|
+
expectations.syntax = :expect
|
|
23
|
+
end
|
|
24
|
+
|
|
25
|
+
config.mock_with :rspec do |mocks|
|
|
26
|
+
mocks.syntax = :expect
|
|
27
|
+
mocks.verify_partial_doubles = true
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
config.after(:example) do
|
|
31
|
+
# We're calling this as a private method because there should not be any
|
|
32
|
+
# reasons to have to flush the service registry except in testing.
|
|
33
|
+
Frodo::ServiceRegistry.instance.send(:flush)
|
|
34
|
+
end
|
|
35
|
+
end
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module FixtureHelpers
|
|
4
|
+
module InstanceMethods
|
|
5
|
+
|
|
6
|
+
def fixture(f)
|
|
7
|
+
File.read(File.expand_path("../../fixtures/#{f}.json", __FILE__))
|
|
8
|
+
end
|
|
9
|
+
end
|
|
10
|
+
end
|
|
11
|
+
|
|
12
|
+
RSpec.configure do |config|
|
|
13
|
+
config.include FixtureHelpers::InstanceMethods
|
|
14
|
+
end
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
module MiddlewareExampleGroup
|
|
2
|
+
def self.included(base)
|
|
3
|
+
base.class_eval do
|
|
4
|
+
let(:app) { double('@app', call: nil) }
|
|
5
|
+
let(:env) { { request_headers: {}, response_headers: {} } }
|
|
6
|
+
let(:retries) { 3 }
|
|
7
|
+
let(:options) { {} }
|
|
8
|
+
let(:client) { double(Frodo::AbstractClient) }
|
|
9
|
+
let(:auth_callback) { double(Proc) }
|
|
10
|
+
|
|
11
|
+
subject(:middleware) { described_class.new app, client, options }
|
|
12
|
+
end
|
|
13
|
+
end
|
|
14
|
+
|
|
15
|
+
RSpec.configure do |config|
|
|
16
|
+
config.include self,
|
|
17
|
+
example_group: { file_path: %r{spec/frodo/middleware} }
|
|
18
|
+
end
|
|
19
|
+
end
|