├── .clj-kondo
└── config.edn
├── .gitignore
├── .travis.yml
├── Dockerfile
├── Dockerfile.jetty
├── Procfile
├── README.md
├── UNLICENSE
├── app.json
├── circle.yml
├── dev
└── dev.clj
├── manifest.yml
├── package.json
├── project.clj
├── resources
├── config.edn
├── logback.xml
├── pages
│ └── index.html
├── public
│ └── css
│ │ └── main.css
└── styles
│ └── main.scss
├── src
└── ephemeris_api
│ ├── config.clj
│ ├── core.clj
│ ├── server.clj
│ ├── service.clj
│ └── views.clj
├── test
└── ephemeris_api
│ └── core_test.clj
└── yarn.lock
/.clj-kondo/config.edn:
--------------------------------------------------------------------------------
1 | {}
2 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | .DS_Store
2 | *~
3 | .#*
4 | *.log
5 | *.pid
6 |
7 | /logs
8 |
9 | pom.xml*
10 | *.jar
11 | /lib/
12 | /out/
13 | /target/
14 | /classes/
15 | /checkouts/
16 |
17 | # Leiningen
18 | /.lein-*
19 | /.nrepl-*
20 |
21 | # clj-kondo
22 | /.clj-kondo/.cache
23 |
24 | # Node.js
25 | node_modules/
26 | npm-debug.log*
27 |
--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
1 | language: clojure
2 | jdk:
3 | - oraclejdk8
4 | branches:
5 | except:
6 | - test # reserved to auto-deploy & run tests against
7 | - master # deployed with circle-ci for now
8 | notifications:
9 | email:
10 | recipients:
11 | - open@astrolin.org
12 | on_success: change
13 | on_failure: always
14 | deploy:
15 | provider: heroku
16 | on: active
17 | app: ephemeris
18 | api_key:
19 | secure: qcpqs3CfaIUXY+FZ4sN5y/bRZV3Gk8qMHLcYxkKdG8UUDG1rxSivISefotTaMPvzYxyt6NLf0iLde9P6mlkjEJBJ1sjJRa3l9Yb7p0lXidyaM3yWoMgEo9diHWpDNC93rPBTXABDpZj0sqF3pbPDWOUXcFF/rELOTqiDi9T9jPO9orT6oXdzSTmX3y9Kq7UfobqEhUhV69+n+wkaIoBRRLyoridOMpYGrszZiA/PLro5lOODw1oLiPZTvg3QD9IEU7Gn4uLyKf4cl55Rw3MT6TEUDjxQC0AxdpTm+ad0a+Gntiact110lCNUnlwapB/PivJteLgjoBxZMctkZZ1LORg4z1k/L8t7EFDleDnWRlwbbAYB7Fn4VH4rDpG6ooAsDu5RYJNPsIggiX5ZoDyD4s93wYbIRZc+mpYZeKCdIINtZbHPFG0RCHcWZGRI3wNg7raH1SG7PrQRczhUIvPPaEBMNE0SNoe0aLvQlTZOAhJqbvgDRfb3yzHJbrN6jjAliWlSRimF7S8m9g08i+gCIhkfC2tldLNpR/9WfVHpfrFg2InYuf7eyxhXNanPLCPTpnntfgrjTIrPyZoV4SKEsjzGOpYjuienLCPiZbHcbgTN+6GbpWHCjDlxUEr2eg3WAi+M6XCz4+n71Xv2fEMUVGTgteiR3WLwLWXbLv+hMtI=
20 |
--------------------------------------------------------------------------------
/Dockerfile:
--------------------------------------------------------------------------------
1 | FROM java:8
2 |
3 | ADD target/server.jar /srv/ephemeris-api.jar
4 |
5 | EXPOSE 8080
6 |
7 | CMD ["java", "-Dnomad.env=prod", "-jar", "/srv/ephemeris-api.jar"]
8 |
--------------------------------------------------------------------------------
/Dockerfile.jetty:
--------------------------------------------------------------------------------
1 | FROM java:8
2 |
3 | ADD target/server.jar /srv/ephemeris-api.jar
4 |
5 | EXPOSE 8080
6 |
7 | # These logging modules only apply to :jetty deployments,
8 | # using io.pedestal/pedestal.jetty adapter
9 | # which may or may not be the case...
10 | CMD ["mkdir", "/srv/modules"]
11 | CMD ["cd", "/srv/modules"]
12 | CMD ["curl" "-O" "https://raw.githubusercontent.com/jetty-project/logging-modules/master/capture-all/logging.mod"]
13 | CMD ["curl" "-O" "https://raw.githubusercontent.com/jetty-project/logging-modules/master/centralized/webapp-logging.mod"]
14 |
15 | CMD ["java", "-Dnomad.env=prod", "-jar", "/srv/ephemeris-api.jar", "--add-to-start=logging,webapp-logging"]
16 |
--------------------------------------------------------------------------------
/Procfile:
--------------------------------------------------------------------------------
1 | web: $JVM_OPTS java -Dnomad.env=prod -Dephemeris.api.port=$PORT -Dephemeris.api.base=/ -jar target/server.jar
2 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # ephemeris-api
2 |
3 | > Ephemeris HTTP API
4 |
5 | This `ephemeris-api` provides [ephemeris](https://github.com/astrolet/ephemeris) functionality, over the HTTP protocol, as a web service. It is powered by [Pedestal](http://pedestal.io), including adaptors for [Jetty](http://www.eclipse.org/jetty) and [Immutant](http://immutant.org). Pedestal opens up a "huge variety" of deployment possibilities, not all of which enabled or documented here. Thanks also go to [pedestal-api](https://github.com/oliyh/pedestal-api) for making it simple and easy.
6 |
7 | ## Rationale
8 |
9 | For the purpose of decoupling astrology applications from ephemeris code. Therefore one is free to implement an application in any programming language and using a data format of their choice. There is also the possibility of including and exposing alternative ephemeris implementations with the same interface. Client applications would simply connect to an api instance configured to serve the ephemeris they want to use / make available to their customers. Application users with privacy or other concerns (e.g. self-service of low connectivity environments wanting Internet-independent use through local area network, or a fully-offline desktop `localhost`), can easily provide the ephemeris for themselves and for free, as long as their application allows for such configuration of an ephemeris endpoint.
10 |
11 | The best or most popular astrology software is generally behind the times with regards to rapid tech industry change in a post-desktop world. The barrier to entry appears high, costly, even intimidating. Programming astrology is complicated enough. An ephemeris should make it easier rather than harder to attract a new generation of hackers, keeping astrology enthusiasm alive. An ephemeris interface (i.e. its api) should have a relatively small footprint. Its purpose is to convert one kind of data, i.e. time and place — into another, e.g. positions of planets, stars, a few key points on the ecliptic, and *"testimonies"* come to mind. A simple non-side-effecting single-purpose transformation function. Pretty much everything else necessary for the practice of, at least traditional, natal astrology can be derived from this functional ephemeris data by external or third party code libraries. An ephemeris that aims to do nothing more than the absolute bare minimum is easy to improve or replace. The same applies to libraries that would transform this data further, into something fit for the practice of astrology, such as a graphical user interface. Scripted rather than compiled languages can be used for lightweight development. Poor determined hackers with weak computers can be efficient, successful astrology programmers too. This almost levels the playing field.
12 |
13 | We live in a grey world. Commercial vs GPL licensing is too black-and-white for a healthy and thriving astrology software ecosystem. Permissive licenses such as MIT are the popular trend for a reason. The public domain is on the rise. People should be free to choose Open Source other than strict copyleft GPL. The [Unlicense](http://unlicense.org) this organization adopts for its code - takes a strong and clear stance.
14 |
15 | By serving the ephemeris api over network protocols and keeping it minimal, we open possibilities for an alternate future of astrology apps. Any ephemeris-dependent software can ship without an ephemeris and work with any other ephemeris that conforms to a common interface spec. Ephemeris would be a utility that people can choose to self-provide in the Cloud, on a LAN, or any network with [ZeroTier](https://www.zerotier.com). That would lower the cost for end-users and app developers alike. Apps would be leaner and cheaper. Micro-apps that do very little and are almost free become viable. Their authors could put such apps on the market without having to afford an ephemeris license, nor the hosting cost of an ephemeris-api, and thus not loose any money if an app fails to summon interest in people. Even developers from "Third World" countries could compete globally. If an app does well, it may eventually get an upgrade, perhaps with a more expensive ephemeris-including version. This is a kind of crowdfunding without asking people for funds in advance.
16 |
17 | Furthermore, commercial apps would outlive their authors’ ability to renew their ephemeris license and stick around for the benefit of astrologers even if an ephemeris license is revoked or a specific ephemeris-api service ceases to exist. Overall, this should pave the way for better astrology software in the small and at large. Competition wouldn’t have to be monolithic nor “reinventing the wheel” once again.
18 |
19 | Remember this is just sharing thoughts about possibilities. Check for yourself and with a lawyer that whatever course you take and choices you make are all legal.
20 |
21 | ## Caution
22 |
23 | Before you go on, keep in mind there isn’t much here yet. The `ephemeris` that will be made available is still very incomplete and this isn't even on par with it. Nevertheless, the course is set and we’ll get there. Meanwhile, it's a *"work in progress"*…
24 |
25 | ## Use
26 |
27 | Try a demo [api.astrolin.org](http://api.astrolin.org)/.
28 | It has got an automatically-generated, self-documenting ui.
29 |
30 | ### Development
31 |
32 | [OpenJDK](https://adoptopenjdk.net/?variant=openjdk11&jvmVariant=hotspot) `11` and [Leiningen](https://leiningen.org) `2.4` or greater are prerequisites.
33 |
34 | Start `lein repl`, load the `dev` namespace, and call `-main`.
35 | Source code will be auto-reloaded upon changes for easier dev,
36 | thanks to [ns-tracker](https://github.com/weavejester/ns-tracker).
37 |
38 | Running `lein repl` will take you to `ns dev` by default -- then:
39 |
40 | ```clojure
41 | (-main)
42 | ```
43 |
44 | ### Standalone Package
45 |
46 | ```sh
47 | lein do clean, uberjar
48 | java -Dnomad.env=prod -jar target/server.jar
49 | ```
50 |
51 | ### Cofiguration
52 |
53 | There are [nomad](https://github.com/jarohen/nomad) defaults pre-configured per environment in `resources/config.edn` that can be overridden in a number of ways. Currently either through environment variables or Java system properties. For example the following two commands will do the same:
54 |
55 | - ` EPHEMERIS_API_PORT=8080 java -jar target/server.jar`
56 | - `java -Dephemeris.api.port=8080 -jar target/server.jar`
57 |
58 | If you use both approaches together, e.g. `EPHEMERIS_API_PORT=8080 java -Dephemeris.api.port=8081 -jar target/server.jar`, then the second one wins and the port would be `8081`.
59 |
60 | See [environ](https://github.com/weavejester/environ#readme)’s documentation for more info / possibilities. The following vars, or their `java`-option equivalents, will be used if provided:
61 |
62 | * `EPHEMERIS_API_EVER` can make api version be different from `project.clj`'s
63 | * `EPHEMERIS_API_BASE` the path where the api is served, e.g. `/`
64 | * `EPHEMERIS_API_TYPE` = `jetty` or `immutant`
65 | * `EPHEMERIS_API_HOST`
66 | * `EPHEMERIS_API_PORT`
67 |
68 | ## Deploy
69 |
70 | There are many ways one can deploy the api, to Cloud platforms being many.
71 | Here are some that have been tried, mostly for their convenience and free tier.
72 |
73 | ### Heroku
74 |
75 | Host your own Ephemeris API server for **FREE** on [Heroku](https://heroku.com) with [One-Click Deploy](https://heroku.com/deploy?template=https://github.com/astrolin/ephemeris-api/tree/master).
76 |
77 | [](https://heroku.com/deploy?template=https://github.com/astrolin/ephemeris-api/tree/master)
78 |
79 | Already on Heroku at [ephemeris.herokuapp.com](https://ephemeris.herokuapp.com) with a free instance -
80 | that is automatically deployed from the `active` branch and used for testing as [test.astrolin.org](http://test.astrolin.org).
81 | It could be broken on occasion, as *work in progress*.
82 |
83 | ### Bluemix
84 |
85 | [IBM Bluemix](https://www.ibm.com/cloud-computing/bluemix) also offers 512 MB for FREE, except that your app won't fall aseep due to inactivity.
86 | You may need a slightly different [manifest](https://github.com/astrolin/ephemeris-api/blob/active/manifest.yml).
87 |
88 | ### OpenShift
89 |
90 | [OpenShift Origin](https://www.openshift.org) is interesting for its [WildFly](http://wildfly.org) offering, which is especially well-suited for [Immutant](http://immutant.org), our default production adapter type, all of these being backed by RedHat. The `lein immutant war` here for this reason hasn't been deployed successfully yet. At the time of this writing the platform is still in preview mode with that has to be renewed each month, as accounts are forced to expire. It'd be great to eventially verify it working.
91 |
92 | ## License
93 |
94 | [Unlicensed](http://unlicense.org) free and unencumbered public domain software.
95 |
96 | [Ephemeris LICENSE](https://github.com/astrolet/ephemeris/blob/active/LICENSE)
97 | applies in order to use the api - which currently means:
98 | [Swiss Ephemeris License](http://www.astro.com/swisseph).
99 |
--------------------------------------------------------------------------------
/UNLICENSE:
--------------------------------------------------------------------------------
1 | This is free and unencumbered software released into the public domain.
2 |
3 | Anyone is free to copy, modify, publish, use, compile, sell, or
4 | distribute this software, either in source code form or as a compiled
5 | binary, for any purpose, commercial or non-commercial, and by any
6 | means.
7 |
8 | In jurisdictions that recognize copyright laws, the author or authors
9 | of this software dedicate any and all copyright interest in the
10 | software to the public domain. We make this dedication for the benefit
11 | of the public at large and to the detriment of our heirs and
12 | successors. We intend this dedication to be an overt act of
13 | relinquishment in perpetuity of all present and future rights to this
14 | software under copyright law.
15 |
16 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17 | EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18 | MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19 | IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
20 | OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21 | ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
22 | OTHER DEALINGS IN THE SOFTWARE.
23 |
24 | For more information, please refer to
2 |
3 |
4 | %-5level %logger{36} - %msg%n
5 |
6 |
7 | INFO
8 |
9 |
10 |
11 |
12 |
14 |
15 |
20 |
--------------------------------------------------------------------------------
/resources/pages/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 | Welcome to Ephemeris API
5 |