├── .babelrc ├── .github ├── FUNDING.yml ├── ISSUE_TEMPLATE │ ├── bug_report.md │ └── feature_request.md └── pull_request_template.md ├── .gitignore ├── .npmignore ├── CODE_OF_CONDUCT.md ├── CONTRIBUTING.md ├── LICENSE ├── README.md ├── index.js ├── package.json ├── social.png └── src └── gatsby-node.js /.babelrc: -------------------------------------------------------------------------------- 1 | { 2 | "presets": [ 3 | ["babel-preset-gatsby-package"] 4 | ] 5 | } -------------------------------------------------------------------------------- /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | # These are supported funding model platforms 2 | 3 | github: [atapas] 4 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug_report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug report 3 | about: Create a report to help us improve 4 | title: '' 5 | labels: '' 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Describe the bug** 11 | A clear and concise description of what the bug is. 12 | 13 | **To Reproduce** 14 | Steps to reproduce the behavior: 15 | 1. Go to '...' 16 | 2. Click on '....' 17 | 3. Scroll down to '....' 18 | 4. See error 19 | 20 | **Expected behavior** 21 | A clear and concise description of what you expected to happen. 22 | 23 | **Screenshots** 24 | If applicable, add screenshots to help explain your problem. 25 | 26 | **Desktop (please complete the following information):** 27 | - OS: [e.g. iOS] 28 | - Browser [e.g. chrome, safari] 29 | - Version [e.g. 22] 30 | 31 | **Smartphone (please complete the following information):** 32 | - Device: [e.g. iPhone6] 33 | - OS: [e.g. iOS8.1] 34 | - Browser [e.g. stock browser, safari] 35 | - Version [e.g. 22] 36 | 37 | **Additional context** 38 | Add any other context about the problem here. 39 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Feature request 3 | about: Suggest an idea for this project 4 | title: '' 5 | labels: '' 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Is your feature request related to a problem? Please describe.** 11 | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] 12 | 13 | **Describe the solution you'd like** 14 | A clear and concise description of what you want to happen. 15 | 16 | **Describe alternatives you've considered** 17 | A clear and concise description of any alternative solutions or features you've considered. 18 | 19 | **Additional context** 20 | Add any other context or screenshots about the feature request here. 21 | -------------------------------------------------------------------------------- /.github/pull_request_template.md: -------------------------------------------------------------------------------- 1 | - Please provide a reference to a related issue in your repository. 2 | 3 | 4 | 5 | - Please provide a description of the changes proposed in the pull request. 6 | 7 | 8 | 9 | - Please @mentions of the person or team responsible for reviewing proposed changes. 10 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | /gatsby-node.js -------------------------------------------------------------------------------- /.npmignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | src 3 | .babelrc -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | We as members, contributors, and leaders pledge to make participation in our 6 | community a harassment-free experience for everyone, regardless of age, body 7 | size, visible or invisible disability, ethnicity, sex characteristics, gender 8 | identity and expression, level of experience, education, socio-economic status, 9 | nationality, personal appearance, race, religion, or sexual identity 10 | and orientation. 11 | 12 | We pledge to act and interact in ways that contribute to an open, welcoming, 13 | diverse, inclusive, and healthy community. 14 | 15 | ## Our Standards 16 | 17 | Examples of behavior that contributes to a positive environment for our 18 | community include: 19 | 20 | * Demonstrating empathy and kindness toward other people 21 | * Being respectful of differing opinions, viewpoints, and experiences 22 | * Giving and gracefully accepting constructive feedback 23 | * Accepting responsibility and apologizing to those affected by our mistakes, 24 | and learning from the experience 25 | * Focusing on what is best not just for us as individuals, but for the 26 | overall community 27 | 28 | Examples of unacceptable behavior include: 29 | 30 | * The use of sexualized language or imagery, and sexual attention or 31 | advances of any kind 32 | * Trolling, insulting or derogatory comments, and personal or political attacks 33 | * Public or private harassment 34 | * Publishing others' private information, such as a physical or email 35 | address, without their explicit permission 36 | * Other conduct which could reasonably be considered inappropriate in a 37 | professional setting 38 | 39 | ## Enforcement Responsibilities 40 | 41 | Community leaders are responsible for clarifying and enforcing our standards of 42 | acceptable behavior and will take appropriate and fair corrective action in 43 | response to any behavior that they deem inappropriate, threatening, offensive, 44 | or harmful. 45 | 46 | Community leaders have the right and responsibility to remove, edit, or reject 47 | comments, commits, code, wiki edits, issues, and other contributions that are 48 | not aligned to this Code of Conduct, and will communicate reasons for moderation 49 | decisions when appropriate. 50 | 51 | ## Scope 52 | 53 | This Code of Conduct applies within all community spaces, and also applies when 54 | an individual is officially representing the community in public spaces. 55 | Examples of representing our community include using an official e-mail address, 56 | posting via an official social media account, or acting as an appointed 57 | representative at an online or offline event. 58 | 59 | ## Enforcement 60 | 61 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 62 | reported to the community leaders responsible for enforcement at 63 | tapas.adhikary@gmail.com. 64 | All complaints will be reviewed and investigated promptly and fairly. 65 | 66 | All community leaders are obligated to respect the privacy and security of the 67 | reporter of any incident. 68 | 69 | ## Enforcement Guidelines 70 | 71 | Community leaders will follow these Community Impact Guidelines in determining 72 | the consequences for any action they deem in violation of this Code of Conduct: 73 | 74 | ### 1. Correction 75 | 76 | **Community Impact**: Use of inappropriate language or other behavior deemed 77 | unprofessional or unwelcome in the community. 78 | 79 | **Consequence**: A private, written warning from community leaders, providing 80 | clarity around the nature of the violation and an explanation of why the 81 | behavior was inappropriate. A public apology may be requested. 82 | 83 | ### 2. Warning 84 | 85 | **Community Impact**: A violation through a single incident or series 86 | of actions. 87 | 88 | **Consequence**: A warning with consequences for continued behavior. No 89 | interaction with the people involved, including unsolicited interaction with 90 | those enforcing the Code of Conduct, for a specified period of time. This 91 | includes avoiding interactions in community spaces as well as external channels 92 | like social media. Violating these terms may lead to a temporary or 93 | permanent ban. 94 | 95 | ### 3. Temporary Ban 96 | 97 | **Community Impact**: A serious violation of community standards, including 98 | sustained inappropriate behavior. 99 | 100 | **Consequence**: A temporary ban from any sort of interaction or public 101 | communication with the community for a specified period of time. No public or 102 | private interaction with the people involved, including unsolicited interaction 103 | with those enforcing the Code of Conduct, is allowed during this period. 104 | Violating these terms may lead to a permanent ban. 105 | 106 | ### 4. Permanent Ban 107 | 108 | **Community Impact**: Demonstrating a pattern of violation of community 109 | standards, including sustained inappropriate behavior, harassment of an 110 | individual, or aggression toward or disparagement of classes of individuals. 111 | 112 | **Consequence**: A permanent ban from any sort of public interaction within 113 | the community. 114 | 115 | ## Attribution 116 | 117 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], 118 | version 2.0, available at 119 | https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. 120 | 121 | Community Impact Guidelines were inspired by [Mozilla's code of conduct 122 | enforcement ladder](https://github.com/mozilla/diversity). 123 | 124 | [homepage]: https://www.contributor-covenant.org 125 | 126 | For answers to common questions about this code of conduct, see the FAQ at 127 | https://www.contributor-covenant.org/faq. Translations are available at 128 | https://www.contributor-covenant.org/translations. 129 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing 2 | 3 | When contributing to this repository, please first discuss the change you wish to make via issue, 4 | email, or any other method with the owners of this repository before making a change. 5 | 6 | Please note we have a code of conduct, please follow it in all your interactions with the project. 7 | 8 | ## Pull Request Process 9 | 10 | 1. Ensure any install or build dependencies are removed before the end of the layer when doing a 11 | build. 12 | 2. Update the README.md with details of changes to the interface, this includes new environment 13 | variables, exposed ports, useful file locations and container parameters. 14 | 3. Increase the version numbers in any examples files and the README.md to the new version that this 15 | Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/). 16 | 4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you 17 | do not have permission to do that, you may request the second reviewer to merge it for you. 18 | 19 | ## Code of Conduct 20 | 21 | ### Our Pledge 22 | 23 | In the interest of fostering an open and welcoming environment, we as 24 | contributors and maintainers pledge to making participation in our project and 25 | our community a harassment-free experience for everyone, regardless of age, body 26 | size, disability, ethnicity, gender identity and expression, level of experience, 27 | nationality, personal appearance, race, religion, or sexual identity and 28 | orientation. 29 | 30 | ### Our Standards 31 | 32 | Examples of behavior that contributes to creating a positive environment 33 | include: 34 | 35 | * Using welcoming and inclusive language 36 | * Being respectful of differing viewpoints and experiences 37 | * Gracefully accepting constructive criticism 38 | * Focusing on what is best for the community 39 | * Showing empathy towards other community members 40 | 41 | Examples of unacceptable behavior by participants include: 42 | 43 | * The use of sexualized language or imagery and unwelcome sexual attention or 44 | advances 45 | * Trolling, insulting/derogatory comments, and personal or political attacks 46 | * Public or private harassment 47 | * Publishing others' private information, such as a physical or electronic 48 | address, without explicit permission 49 | * Other conduct which could reasonably be considered inappropriate in a 50 | professional setting 51 | 52 | ### Our Responsibilities 53 | 54 | Project maintainers are responsible for clarifying the standards of acceptable 55 | behavior and are expected to take appropriate and fair corrective action in 56 | response to any instances of unacceptable behavior. 57 | 58 | Project maintainers have the right and responsibility to remove, edit, or 59 | reject comments, commits, code, wiki edits, issues, and other contributions 60 | that are not aligned to this Code of Conduct, or to ban temporarily or 61 | permanently any contributor for other behaviors that they deem inappropriate, 62 | threatening, offensive, or harmful. 63 | 64 | ### Scope 65 | 66 | This Code of Conduct applies both within project spaces and in public spaces 67 | when an individual is representing the project or its community. Examples of 68 | representing a project or community include using an official project e-mail 69 | address, posting via an official social media account, or acting as an appointed 70 | representative at an online or offline event. Representation of a project may be 71 | further defined and clarified by project maintainers. 72 | 73 | ### Enforcement 74 | 75 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 76 | reported by contacting the project team at [tapas.adhikary@gmail.com](tapas.adhikary@gmail.com). All 77 | complaints will be reviewed and investigated and will result in a response that 78 | is deemed necessary and appropriate to the circumstances. The project team is 79 | obligated to maintain confidentiality with regard to the reporter of an incident. 80 | Further details of specific enforcement policies may be posted separately. 81 | 82 | Project maintainers who do not follow or enforce the Code of Conduct in good 83 | faith may face temporary or permanent repercussions as determined by other 84 | members of the project's leadership. 85 | 86 | ### Attribution 87 | 88 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, 89 | available at [http://contributor-covenant.org/version/1/4][version] 90 | 91 | [homepage]: http://contributor-covenant.org 92 | [version]: http://contributor-covenant.org/version/1/4/ 93 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2021 Tapas Adhikary 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # gatsby-source-harperdb 2 | 3 |

4 | social 5 |

6 | 7 | ## Description 8 | 9 | [HarperDB](https://harperdb.io/) is a fast, flexible database that allows you to perform rapid application development, distributed computing, SaaS, and many more. On the other hand, [Gatsbyjs](https://www.gatsbyjs.com/) is a React-based framework that allows you to build fast, secure, and robust websites. 10 | 11 | Gatsby's massive plugin ecosystem allows us to pull data from several data sources, avail themes, and many more use-cases. The `gatsby-source-harperdb` plugin allows you to use the `HarperDB` as the data source so that a Gatsby project can pull the data at the build time. 12 | 13 | It will help any `Gatsbyjs` app to create a prebuilt markup with the data from `HarperDB`. 14 | 15 | ### Learning Resources 16 | 17 | Here a few learning resources you may find helpful, 18 | 19 | - [Getting started with HarperDB](https://studio.harperdb.io/sign-up) 20 | - [How Gatsby Works?](https://www.gatsbyjs.com/how-it-works/) 21 | 22 | ## How to install 23 | 24 | To install the plugin for your Gatsby project, use this command, 25 | 26 | ```shell 27 | npm i gatsby-source-harperdb 28 | 29 | # If you are using yarn, try this, 30 | # yarn add gatsby-source-harperdb 31 | ``` 32 | 33 | Please note: `Gatsby` documentation uses `npm` for installation. It is the recommended approach for plugins as well. However, my test with `yarn` also went well. 34 | ## When do I use this plugin? 35 | 36 | You would use this plugin when you want to fetch data from the `HarperDB` in advance at the build time. The `gatsby build` command will build the project and create prebuilt markups along with the data. Thus, it will make the initial page load of your application faster. The bonus is, you achieve `Jamstack` as well. 37 | 38 | > Please note: To get the dynamic data at a later point of time from the `HarperDB`, you need to perform regular calls using `axios`, `node-fetch`, etc. 39 | ## Examples of usage 40 | In your Gatsbyjs project, make an entry in the `plugins` array in the `gatsby-config.js` file. 41 | 42 | ```js 43 | plugins: [ 44 | ... 45 | { 46 | resolve: `gatsby-source-harperdb`, 47 | options: { 48 | secret: "_YOUR_HARPERDB_SECRET_KEY_", 49 | url: "_YOUR_HARPERDB_URL_", 50 | payload: { 51 | "operation": "sql", 52 | "sql":"SELECT * FROM library.book" 53 | }, 54 | type: "books" 55 | }, 56 | }, 57 | ], 58 | ``` 59 | The options are, 60 | - `secret`: Provide the `HarperDB` secret key. After setting up an instance on HarperDB, you can find it in the `example code` section. We use this secret key in the `Authorization` header. 61 | - `url`: The URL to connect to the HarperDB instance. For example, if you have created an instance on the cloud, you may have got a URL like, `https://xxxxxx.harperdbcloud.com` 62 | - `payload`: Here, you pass the type of operation and the query to perform on the HarperDB database. In most cases, you would use a `SELECT` query here. You can also pass a query using joins. 63 | - `type`: It can be any string of your choice. It is the name under which your data will appear in Gatsby GraphQL queries. For example, if we specify `books` as the type name, Gatsby will create GraphQL queries as `allBooks` and `books`. 64 | 65 | ## How to query for data 66 | 67 | To query the data use GraphQL query like this, 68 | 69 | ```gql 70 | query MyQuery { 71 | allBooks { 72 | nodes { 73 | rating 74 | publisher 75 | } 76 | } 77 | } 78 | ``` 79 | It will return the rating and the publisher's name of all the books in the database. 80 | 81 | ```json 82 | { 83 | "data": { 84 | "allBooks": { 85 | "nodes": [ 86 | { 87 | "rating": 0, 88 | "publisher": "Manning" 89 | }, 90 | { 91 | "rating": 0, 92 | "publisher": "O'Reilly Media" 93 | }, 94 | { 95 | "rating": 0, 96 | "publisher": "No Starch Press" 97 | }, 98 | { 99 | "rating": 0, 100 | "publisher": "O'Reilly Media" 101 | }, 102 | { 103 | "rating": 0, 104 | "publisher": "O'Reilly Media" 105 | }, 106 | { 107 | "rating": 4.5, 108 | "publisher": "No Starch Press" 109 | }, 110 | { 111 | "rating": 4, 112 | "publisher": "O'Reilly Media" 113 | }, 114 | { 115 | "rating": 5, 116 | "publisher": "O'Reilly Media" 117 | } 118 | ] 119 | } 120 | }, 121 | "extensions": {} 122 | } 123 | ``` 124 | How about applying a filter? Let's query the books with a rating of more than 4. 125 | 126 | ```gql 127 | query MyQuery { 128 | allBooks(filter: {rating: {gt: 4}}) { 129 | nodes { 130 | rating 131 | title 132 | } 133 | } 134 | } 135 | ``` 136 | It will output, 137 | 138 | ```json 139 | { 140 | "data": { 141 | "allBooks": { 142 | "nodes": [ 143 | { 144 | "rating": 4.5, 145 | "title": "Understanding ECMAScript 6" 146 | }, 147 | { 148 | "rating": 5, 149 | "title": "You Don't Know JS" 150 | } 151 | ] 152 | } 153 | }, 154 | "extensions": {} 155 | } 156 | ``` 157 | Now, you can use queries like these in the Gatsbyjs pages and components. 158 | ## How to contribute 159 | 160 | Thank you for using `gatsby-source-harperdb,` and I hope you find it helpful. If you face any issues or got an enhancement request, please consider logging the [issue](https://github.com/atapas/gatsby-source-harperdb/issues) or opening a [pull request](https://github.com/atapas/gatsby-source-harperdb/pulls). All contributions are welcome. 161 | -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | // noop -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "gatsby-source-harperdb", 3 | "version": "1.0.2", 4 | "description": "A Gatsby source plugin to fetch data from HarperDB.", 5 | "main": "index.js", 6 | "repository": { 7 | "type": "git", 8 | "url": "git+https://github.com/atapas/gatsby-source-harperdb.git" 9 | }, 10 | "keywords": [ 11 | "gatsby", 12 | "gatsby-plugin", 13 | "harperdb" 14 | ], 15 | "author": "Tapas Adhikary (https://tapasadhikary.com/)", 16 | "license": "MIT", 17 | "bugs": { 18 | "url": "https://github.com/atapas/gatsby-source-harperdb/issues" 19 | }, 20 | "homepage": "https://github.com/atapas/gatsby-source-harperdb#readme", 21 | "dependencies": { 22 | "@babel/runtime": "^7.8.7", 23 | "axios": "^0.21.1" 24 | }, 25 | "devDependencies": { 26 | "@babel/cli": "^7.8.4", 27 | "@babel/core": "^7.8.7", 28 | "babel-preset-gatsby-package": "^0.3.1", 29 | "cross-env": "^5.2.1" 30 | }, 31 | "peerDependencies": { 32 | "gatsby": "^3.0.0" 33 | }, 34 | "scripts": { 35 | "build": "babel src --out-dir .", 36 | "prepare": "cross-env NODE_ENV=production npm run build" 37 | }, 38 | "engines": { 39 | "node": ">=10.13.0" 40 | } 41 | } 42 | -------------------------------------------------------------------------------- /social.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/atapas/gatsby-source-harperdb/40a4b38886abd5065d6b54a715bb7cf347aa9f6e/social.png -------------------------------------------------------------------------------- /src/gatsby-node.js: -------------------------------------------------------------------------------- 1 | 2 | let axios = require('axios'); 3 | exports.sourceNodes = async ( 4 | { actions, createNodeId, createContentDigest }, 5 | options 6 | ) => { 7 | const { createNode } = actions; 8 | const { secret, type, url, payload } = options; 9 | 10 | try { 11 | let data = JSON.stringify(payload); 12 | let config = { 13 | method: 'post', 14 | url: `${url}`, 15 | headers: { 16 | 'Content-Type': 'application/json', 17 | 'Authorization': `Basic ${secret}` 18 | }, 19 | data : data 20 | }; 21 | 22 | let res = await axios(config); 23 | let documents = res.data; 24 | 25 | documents.forEach(document => { 26 | createNode({ 27 | ...document, 28 | id: createNodeId(`harperdb-${document.id}`), 29 | parent: null, 30 | children: [], 31 | internal: { 32 | type: `${type}`, 33 | content: JSON.stringify(document), 34 | contentDigest: createContentDigest(document) 35 | } 36 | }); 37 | }); 38 | } catch (err) { 39 | console.error(err); 40 | } 41 | }; 42 | --------------------------------------------------------------------------------