Skip to content

Commit bf98079

Browse files
spasumarthi21GitHub Enterprise
spasumarthi21
authored and
GitHub Enterprise
committed
feat(new-api-version): Adding v2-2.0.0 sdk (#1)
Summary: * Update class and property names. Breaking changes: * Class Name * OutstandingCalculation -> CalculationStatusSummary * CalculationParameters -> Calculation * OutstandingCalculations -> CalculationStatus (class) * CalculationStatus (enum) -> UnitStatus * Calculation -> CalculationUnitStatus * AccountList -> AccountDirectories * ComponentListEntity -> ComponentSummary * PAComponentEntity -> PAComponent * VaultComponentEntity -> VaultComponent * ConfigurationItem -> VaultConfigurationSummary * ConfigurationRoot -> VaultConfiguration * DateSettings -> DateParametersSummary * DocumentList -> DocumentDirectories * ComponentDateSettings (pa) -> PADateParameters * ComponentDateSettings (vault) -> VaultDateParameters * Properties * pointscount -> points * defaultAccounts (ComponentAccount) -> accounts (PAIdentifier) * defaultBenchmarks (ComponentBenchmark) -> benchmarks (PAIdentifier) * defaultAccount (VaultCalculationAccount) -> accounts (VaultIdentifier) * defaultBenchmark (ComponentBenchmark) -> benchmark (VaultIdentifier) * currency (PAComponentEntity/VaultComponentEntity) -> currencyisocode (PAComponent/VaultComponent) * Methods * getAllCalculationStatusSummaries -> getCalculationStatusSummaries * getAllPAColumnStatistics -> getPAColumnStatistics * getAllPAColumns -> getPAColumns * getPAColumn -> getPAColumnById * getAllPACurrencies -> getPACurrencies * getAllPAFrequencies -> getPAFrequencies * getAllSPARFrequencies -> getSPARFrequencies * getAllVaultFrequencies -> getVaultFrequencies * getAllPAGroups -> getPAGroups * getAllCalculations -> getAllCalculationStatusSummaries * getCalculationById -> getCalculationStatusById * Headers * X-FactSet-Api-PointsCount-Limit -> X-FactSet-Api-Points-Limit * X-FactSet-Api-PointsCount-Remaining -> X-FactSet-Api-Points-Remaining * Currencies * Change response from List to Dictionary with currencyisocode as key Functionality Additions: * New Property snapshot in PAComponent & VaultComponent. Bug Fixes: * No changes.
1 parent 3b40c48 commit bf98079

152 files changed

Lines changed: 16913 additions & 1 deletion

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.gitignore‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Exclude the target folder
2+
target/
3+
.settings/
4+
.factorypath
5+
*.class
6+
*.jar
7+
.vscode/
8+
bin/
9+
.classpath
10+
.project

‎CHANGELOG.md‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
v2-2.0.0 (09/26/2019)
2+
3+
4+
Summary:
5+
* Update class and property names.
6+
7+
Breaking changes:
8+
* Class Name
9+
* OutstandingCalculation -> CalculationStatusSummary
10+
* CalculationParameters -> Calculation
11+
* OutstandingCalculations -> CalculationStatus (class)
12+
* CalculationStatus (enum) -> UnitStatus
13+
* Calculation -> CalculationUnitStatus
14+
* AccountList -> AccountDirectories
15+
* ComponentListEntity -> ComponentSummary
16+
* PAComponentEntity -> PAComponent
17+
* VaultComponentEntity -> VaultComponent
18+
* ConfigurationItem -> VaultConfigurationSummary
19+
* ConfigurationRoot -> VaultConfiguration
20+
* DateSettings -> DateParametersSummary
21+
* DocumentList -> DocumentDirectories
22+
* ComponentDateSettings (pa) -> PADateParameters
23+
* ComponentDateSettings (vault) -> VaultDateParameters
24+
* Column -> ColumnSummary
25+
* Component -> ComponentSummary
26+
* VaultCalculationAccount -> VaultIdentifier
27+
* ComponentBenchmark -> PAIdentifier
28+
* ComponentAccount -> PAIdentifier
29+
* Properties
30+
* pointscount -> points
31+
* defaultAccounts -> accounts
32+
* defaultBenchmarks -> benchmarks
33+
* defaultAccount -> accounts
34+
* defaultBenchmark -> benchmark
35+
* currency -> currencyisocode
36+
* Methods
37+
* getAllCalculationStatusSummaries -> getCalculationStatusSummaries
38+
* getAllPAColumnStatistics -> getPAColumnStatistics
39+
* getAllPAColumns -> getPAColumns
40+
* getPAColumn -> getPAColumnById
41+
* getAllPACurrencies -> getPACurrencies
42+
* getAllPAFrequencies -> getPAFrequencies
43+
* getAllSPARFrequencies -> getSPARFrequencies
44+
* getAllVaultFrequencies -> getVaultFrequencies
45+
* getAllPAGroups -> getPAGroups
46+
* getAllCalculations -> getAllCalculationStatusSummaries
47+
* getCalculationById -> getCalculationStatusById
48+
* Headers
49+
* X-FactSet-Api-PointsCount-Limit -> X-FactSet-Api-Points-Limit
50+
* X-FactSet-Api-PointsCount-Remaining -> X-FactSet-Api-Points-Remaining
51+
* Currencies
52+
* Change response from List to Dictionary with currencyisocode as key
53+
54+
Functionality Additions:
55+
* New Property snapshot in PAComponent & VaultComponent.
56+
57+
58+
Bug Fixes:
59+
* No changes.
60+
61+
-----------------------
62+
63+
64+
v2-1.0.0 (08/30/2019)
65+
66+
67+
Summary:
68+
* Releasing first version of Engines API(v2).
69+
70+
Breaking changes:
71+
* No changes
72+
73+
Functionality Additions:
74+
* Supports PA, SPAR and Vault calculations.
75+
76+
Bug Fixes:
77+
* No changes

‎LICENSE‎

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright 2019 FactSet Research Systems Inc
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

‎README.md‎

Lines changed: 61 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,62 @@
11
# analyticsapi-engines-java-sdk
2-
Java SDK for Engines API
2+
3+
## Overview
4+
API client library to leverage Factset's Analytics API in Java. Each API version directory contains its respective Analytics API implementation.
5+
6+
**`Engines`** - Java library for Engines API. It is developed using [open-api-generator](https://github.com/OpenAPITools/openapi-generator).
7+
8+
**`Utilities`** - Contains the Engines's OpenAPI schema(openapi-schema.json), configuration file(openapi-generator-config.json), custom OpenAPI templates, examples and End-to-end tests of library.
9+
10+
#### Recommended framework
11+
* Java 1.7, Java 1.8
12+
13+
#### Current versions
14+
* API_VERSION - 2
15+
* PACKAGE_VERSION - 2.0.0
16+
17+
## To install the API client library
18+
Add this dependency to project's POM.
19+
```
20+
<dependency>
21+
<groupId>com.factset.analyticsapi</groupId>
22+
<artifactId>engines-java-sdk-vAPI_VERSION</artifactId>
23+
<version>PACKAGE_VERSION</version>
24+
</dependency>
25+
```
26+
27+
## Generating the Java library
28+
To customize OpenAPI generator options and generate the library. Please go through [Open API](https://swagger.io/docs/specification/about/) and [open-api-generator](https://github.com/OpenAPITools/openapi-generator) for more details.
29+
30+
### Pre-requisites
31+
* Install [Java SDK8 64 bit version](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html).
32+
* Clone this `analyticsapi-engines-java-sdk` repository.
33+
* Move into the `analyticsapi-engines-java-sdk/API_VERSION/Utilities/codegen` directory and run the `download-codegen.bat` file by double clicking it (for downloading the openapi-generator-cli.jar).
34+
35+
### To update and build the library
36+
* Move to the `analyticsapi-engines-java-sdk/vAPI_VERSION` location.
37+
* Increment the package version in `Utilities/codegen/openapi-generator-config.json`.
38+
* Delete all the files in the Engines directory excluding `.openapi-generator-ignore` file.
39+
* Replace vAPI_VERSION and PACKAGE_VERSION in the below command with the latest values and run it.
40+
```
41+
javac -classpath Utilities/codegen/*; Utilities/codegen/CustomJavaClientCodegen.java
42+
java -DapiTests=false -DmodelTests=false -classpath Utilities/codegen/;Utilities/codegen/*; org.openapitools.codegen.OpenAPIGenerator generate --generator-name CustomJavaClientCodegen --input-spec Utilities/codegen/openapi-schema.json --output Engines --config Utilities/codegen/openapi-generator-config.json --http-user-agent engines/vAPI_VERSION/PACKAGE_VERSION/java -t Utilities/codegen/templates --skip-validate-spec
43+
```
44+
* Move to the `analyticsapi-engines-java-sdk/vAPI_VERSION/Engines` location, and run `mvn clean package` which generates the library(engines-java-sdk-v*-\*.\*.\*.jar) and its documentation.
45+
46+
### Run End-to-end tests
47+
48+
#### Running the Test Cases
49+
* Move to the `analyticsapi-engines-java-sdk/vAPI_VERSION/Engines` location and build the library.
50+
* Now, move to the `API_VERSION/Utilities/java-sdk-tests` location and run the below commands.
51+
```
52+
mvn clean package
53+
```
54+
* Set the below environment variables.
55+
```
56+
ANALYTICS_API_USERNAME_SERIAL = "username-serial"
57+
ANALYTICS_API_PASSWORD = "apikey" // Generate using developer portal
58+
```
59+
* Now run the test cases using the command below.
60+
```
61+
mvn -q test -Dtest=ApiTestsRunner
62+
```

‎v2/Engines/.gitignore‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
*.class
2+
3+
# Mobile Tools for Java (J2ME)
4+
.mtj.tmp/
5+
6+
# Package Files #
7+
*.jar
8+
*.war
9+
*.ear
10+
11+
# exclude jar for gradle wrapper
12+
!gradle/wrapper/*.jar
13+
14+
# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
15+
hs_err_pid*
16+
17+
# build files
18+
**/target
19+
target
20+
.gradle
21+
build

0 commit comments

Comments
 (0)