Skip to content

Commit

Permalink
Initial release (fredcpp.fossil:b2491d5)
Browse files Browse the repository at this point in the history
  • Loading branch information
nomadbyte committed Jun 13, 2014
0 parents commit f6edd81
Show file tree
Hide file tree
Showing 104 changed files with 53,425 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
build/*
_FOSSIL_
.fslckout
api.key
66 changes: 66 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
fredcpp ChangeLog {#fredcppchangelog}
=================


## 0.6.0 - 2014-03-13

- Add uninstall build target
- Install pugixml headers within fredcpp include
- Cleanup source tree
- Update documentation
- Make request parameters case-insensitive

- __ISSUE__:FRED API parameter "file_type" supports only default "xml" value;
- All FRED data is properly fetched directly via XML, so other file types are
just different in formatting conventions. However, an ability to download
FRED files may be considered as an additional feature if requested.

- __ISSUE__:FRED API parameter "tags" (for categories) is not directly supported.
- WORKAROUND:Specify in request as a generic parameter via `with("tags","keywords...")`
method.


## 0.5.0 - 2013-06-25

- __ISSUE__:Unexpected internal-error-500 returned from FRED API for SeriesVintageDates,
when realtime-end is after last available vintage data for id.
- WORKAROUND:Just don't make such requests;
Test added - AT:ErrorWhenRealtimeEndAfterLastSeriesVintageDates

- __ISSUE-FIX__:Bad-request returned from FRED API, while the request was valid:\n
- Added retry logic for a failed http request.


## 0.4.0 - 2013-06-02

- Use doxygen to prettyfy documentation
- Add acceptance tests
- Add fredcpp usage examples
- Restructure includes, move up third-party components
- Add SimpleLogger for a basic logger framework
- Add ApiLog logging facility


## 0.3.0 - 2013-04-02

- Add error processing
- Add expressive requests for FRED series, release, category, and source requests
- Add handling for generic entity request parameters
- Restructure the expressive request interface


## 0.2.0 - 2013-02-23

- Add expressive FRED series-observations request
- Add more unit-tests
- Use gtest for testing
- Restructure ApiResponse
- Use pugixml-1.2 for XML response parsing


## 0.1.0 - 2012-12-16

- Handle a generic FRED request with a raw XML response
- Use `cURL` as http client
- Use stream for http content
- Use a generic http request
118 changes: 118 additions & 0 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@

project(fredcpp)

cmake_minimum_required(VERSION 2.6 FATAL_ERROR)

## cmake includes
##
set(CMAKE_MODULE_PATH
"${CMAKE_SOURCE_DIR}/cmake"
"${CMAKE_SOURCE_DIR}/cmake/Modules"
${CMAKE_SOURCE_DIR}
)


## facility version
##
include(DefineFacilityVersion)


## application
##
set(APPLICATION_NAME ${${PROJECT_NAME}_FACILITY})
set(APPLICATION_BRIEF ${${PROJECT_NAME}_BRIEF})

set(APPLICATION_VERSION_MAJOR ${${APPLICATION_NAME}_VERSION_MAJOR})
set(APPLICATION_VERSION_MINOR ${${APPLICATION_NAME}_VERSION_MINOR})
set(APPLICATION_VERSION_PATCH ${${APPLICATION_NAME}_VERSION_PATCH})

set(APPLICATION_VERSION ${${APPLICATION_NAME}_VERSION_STRING})


set(LIBRARY_VERSION APPLICATION_VERSION)
set(LIBRARY_SOVERSION APPLICATION_VERSION_MAJOR)


## definitions
##
include(DefineCMakeDefaults)
include(DefinePlatform)
include(DefineCompilerFlags)
include(DefineInstallationPaths)
include(WithOptions)
include(ConfigureChecks)


## disallow in-source build
##
include(MacroEnsureOutOfSourceBuild)
macro_ensure_out_of_source_build("${PROJECT_NAME} requires an out-of-source build. Please create a separate build directory and run 'cmake /path/to/${PROJECT_NAME} [options]' there.")


## check external dependencies
##
if (WITH_CURL)
find_package(CURL REQUIRED)
endif (WITH_CURL)


## components
##
add_subdirectory(third_party)
add_subdirectory(include)
add_subdirectory(src)
add_subdirectory(doc)



## tests
##
## enable_testing() on the top-level to enable make test target
## OR include CTest for full-blown test support
##
if (WITH_TESTS)
include(DefineApiKey)
enable_testing()
#include(CTest)
add_subdirectory(tests)
endif (WITH_TESTS)

## examples
##
if (WITH_EXAMPLES)
add_subdirectory(examples)
endif (WITH_EXAMPLES)


## Add uninstall target

add_custom_target(uninstall
COMMAND ${CMAKE_COMMAND} -P ${CMAKE_SOURCE_DIR}/cmake/CMakeUninstall.cmake
)


## report

message("---------------------------------------------")
message("BUILD:${APPLICATION_NAME}-${APPLICATION_VERSION} ${CMAKE_BUILD_TYPE}")

message("Http-client:${FREDCPP_BUILD_HTTP_CLIENT}")
message(" CURL:${WITH_CURL}")

message("Xml-parser:${FREDCPP_BUILD_XML_PARSER}")
message(" pugixml:${WITH_PUGIXML}")

message("Logger:${FREDCPP_BUILD_LOGGER}")
message(" SimpleLogger:${WITH_SIMPLELOGGER}")

message("Testing:${WITH_TESTS}")
if (WITH_TESTS)
message(" gtest-at options:'${FREDCPP_GTEST_AT_OPTIONS}'")
message(" gtest-ut options:'${FREDCPP_GTEST_UT_OPTIONS}'")
message(" FRED API key file:'${FREDCPP_API_KEY_FILE}'")
endif (WITH_TESTS)

message("Examples:${WITH_EXAMPLES}")

message("---------------------------------------------")

22 changes: 22 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
fredcpp License {#fredcpplicense}
===============

Copyright (c) 2012 - 2014, Artur Shepilko, <fredcpp@nomadbyte.com>.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
Loading

0 comments on commit f6edd81

Please sign in to comment.