🚀 Initial commit

ditschedev · ditschedev · commit bb6dcff83cd7 · 2020-04-12T15:09:50.000+02:00
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,13 @@
+# editorconfig.org
+root = true
+
+[*]
+indent_size = 2
+indent_style = space
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false
diff --git a/.eslintignore b/.eslintignore
@@ -0,0 +1,8 @@
+# Common
+node_modules
+dist
+.nuxt
+coverage
+
+# Plugin
+lib/plugin.js
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -0,0 +1,10 @@
+module.exports = {
+  root: true,
+  parserOptions: {
+    parser: 'babel-eslint',
+    sourceType: 'module'
+  },
+  extends: [
+    '@nuxtjs'
+  ]
+}
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,45 @@
+name: ci
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  ci:
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        node: [10, 12]
+
+    steps:
+      - uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node }}
+
+      - name: checkout
+        uses: actions/checkout@master
+
+      - name: cache node_modules
+        uses: actions/cache@v1
+        with:
+          path: node_modules
+          key: ${{ matrix.os }}-node-v${{ matrix.node }}-deps-${{ hashFiles(format('{0}{1}', github.workspace, '/yarn.lock')) }}
+
+      - name: Install dependencies
+        if: steps.cache.outputs.cache-hit != 'true'
+        run: yarn
+
+      - name: Lint
+        run: yarn lint
+
+      - name: Test
+        run: yarn test
+
+      - name: Coverage
+        uses: codecov/codecov-action@v1
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,9 @@
+node_modules
+*.iml
+.idea
+*.log*
+.nuxt
+.vscode
+.DS_Store
+coverage
+dist
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Tobias Dittmann
+
+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.
diff --git a/README.md b/README.md
@@ -0,0 +1,61 @@
+# {{ name }}
+
+[![npm version][npm-version-src]][npm-version-href]
+[![npm downloads][npm-downloads-src]][npm-downloads-href]
+[![Github Actions CI][github-actions-ci-src]][github-actions-ci-href]
+[![Codecov][codecov-src]][codecov-href]
+[![License][license-src]][license-href]
+
+> {{ description }}
+
+[📖 **Release Notes**](./CHANGELOG.md)
+
+## Setup
+
+1. Add `{{ name }}` dependency to your project
+
+```bash
+yarn add {{ name }} # or npm install {{ name }}
+```
+
+2. Add `{{ name }}` to the `modules` section of `nuxt.config.js`
+
+```js
+{
+  modules: [
+    // Simple usage
+    '{{ name }}',
+
+    // With options
+    ['{{ name }}', { /* module options */ }]
+  ]
+}
+```
+
+## Development
+
+1. Clone this repository
+2. Install dependencies using `yarn install` or `npm install`
+3. Start development server using `npm run dev`
+
+## License
+
+[MIT License](./LICENSE)
+
+Copyright (c) {{ author }}
+
+<!-- Badges -->
+[npm-version-src]: https://img.shields.io/npm/v/{{ name }}/latest.svg
+[npm-version-href]: https://npmjs.com/package/{{ name }}
+
+[npm-downloads-src]: https://img.shields.io/npm/dt/{{ name }}.svg
+[npm-downloads-href]: https://npmjs.com/package/{{ name }}
+
+[github-actions-ci-src]: https://github.com/{{ github }}/workflows/ci/badge.svg
+[github-actions-ci-href]: https://github.com/{{ github }}/actions?query=workflow%3Aci
+
+[codecov-src]: https://img.shields.io/codecov/c/github/{{ github }}.svg
+[codecov-href]: https://codecov.io/gh/{{ github }}
+
+[license-src]: https://img.shields.io/npm/l/{{ name }}.svg
+[license-href]: https://npmjs.com/package/{{ name }}
diff --git a/babel.config.js b/babel.config.js
@@ -0,0 +1,11 @@
+module.exports = {
+  presets: [
+    [
+      '@babel/preset-env', {
+        targets: {
+          esmodules: true
+        }
+      }
+    ]
+  ]
+}
diff --git a/commitlint.config.js b/commitlint.config.js
@@ -0,0 +1,5 @@
+module.exports = {
+  extends: [
+    '@commitlint/config-conventional'
+  ]
+}
diff --git a/example/nuxt.config.js b/example/nuxt.config.js
@@ -0,0 +1,14 @@
+const { resolve } = require('path')
+
+module.exports = {
+  rootDir: resolve(__dirname, '..'),
+  buildDir: resolve(__dirname, '.nuxt'),
+  srcDir: __dirname,
+  modules: [
+    '../lib/module'
+  ],
+  ghost: {
+    url: 'https://demo.ghost.io',
+    key: '22444f78447824223cefc48062'
+  }
+}
diff --git a/example/pages/index.vue b/example/pages/index.vue
@@ -0,0 +1,25 @@
+<template>
+  <div>
+    Works!
+  </div>
+</template>
+
+<script>
+export default {
+  async asyncData ({ $ghost }) {
+    const posts = await $ghost.getPosts()
+    const authors = await $ghost.getAuthors()
+    const tags = await $ghost.getTags()
+    const pages = await $ghost.getPages()
+    const settings = await $ghost.getSettings()
+
+    return {
+      posts,
+      authors,
+      tags,
+      pages,
+      settings
+    }
+  }
+}
+</script>
diff --git a/husky.config.js b/husky.config.js
@@ -0,0 +1,7 @@
+module.exports = {
+  hooks: {
+    'commit-msg': 'commitlint -E HUSKY_GIT_PARAMS',
+    'pre-commit': 'yarn lint',
+    'pre-push': 'yarn lint'
+  }
+}
diff --git a/jest.config.js b/jest.config.js
@@ -0,0 +1,17 @@
+module.exports = {
+  testEnvironment: 'node',
+  collectCoverage: true,
+  collectCoverageFrom: [
+    'lib/**/*.js',
+    '!lib/plugin.js'
+  ],
+  moduleNameMapper: {
+    '^~/(.*)$': '<rootDir>/lib/$1',
+    '^~~$': '<rootDir>',
+    '^@@$': '<rootDir>',
+    '^@/(.*)$': '<rootDir>/lib/$1'
+  },
+  transform: {
+    '^.+\\.js$': 'babel-jest'
+  }
+}
diff --git a/lib/module.js b/lib/module.js
@@ -0,0 +1,35 @@
+const { resolve } = require('path')
+
+module.exports = function (_moduleOptions) {
+  const moduleOptions = {
+    ...this.options.ghost,
+    ..._moduleOptions
+  }
+
+  const options = {
+    version: 'v3',
+    ...moduleOptions
+  }
+
+  if (!options.key || !options.url) {
+    throw new Error('[Ghost] Please provide your sites url and the api key.')
+  }
+
+  if (!/https?:\/\//.test(options.url)) {
+    throw new Error('[Ghost] Your given url has no protocol.')
+  }
+  if (options.url.endsWith('/')) {
+    throw new Error('[Ghost] Your given url has a trailing slash.')
+  }
+  if (!/[0-9a-f]{26}/.test(options.key)) {
+    throw new Error('[Ghost] Invalid api key. Api keys have 26 hexadecimal characters.')
+  }
+
+  this.addPlugin({
+    src: resolve(__dirname, 'plugin.js'),
+    fileName: 'ghost.js',
+    options
+  })
+}
+
+module.exports.meta = require('../package.json')
diff --git a/lib/plugin.js b/lib/plugin.js
@@ -0,0 +1,92 @@
+import GhostContentAPI from '@tryghost/content-api';
+
+class Ghost {
+    constructor(url, key, version) {
+        this.url = url;
+        this.key = key;
+        this.version = version;
+        this._init();
+    }
+
+    _init() {
+        this._client = new GhostContentAPI({
+            url: '<%= options.url %>',
+            key: '<%= options.key %>',
+            version: '<%= options.version %>'
+        });
+    }
+
+    async getPosts(filter = {}) {
+        const [posts] = await Promise.all([
+            this._client.posts.browse(filter)
+        ]);
+        return posts;
+    }
+
+    async getPost(filter, options = {}) {
+        if(!filter) throw new Error('[Ghost] You need to provide a filter to read a post.');
+        const [post] = await Promise.all([
+            this._client.posts.read(filter, options)
+        ]);
+        return post;
+    }
+
+    async getAuthors(filter) {
+        const [authors] = await Promise.all([
+            this._client.authors.browse(filter)
+        ]);
+        return authors;
+    }
+
+    async getAuthor(filter, options = {}) {
+        if(!filter) throw new Error('[Ghost] You need to provide a filter to read an author.');
+        const [author] = await Promise.all([
+            this._client.authors.read(filter, options)
+        ]);
+        return author;
+    }
+
+    async getTags(filter) {
+        const [tags] = await Promise.all([
+            this._client.tags.browse(filter)
+        ]);
+        return tags;
+    }
+
+    async getTag(filter, options = {}) {
+        if(!filter) throw new Error('[Ghost] You need to provide a filter to read a tag.');
+        const [tag] = await Promise.all([
+            this._client.tags.read(filter, options)
+        ]);
+        return tag;
+    }
+
+    async getPages(filter) {
+        const [pages] = await Promise.all([
+            this._client.pages.browse(filter)
+        ]);
+        return pages;
+    }
+
+    async getPage(filter, options = {}) {
+        if(!filter) throw new Error('[Ghost] You need to provide a filter to read a page.');
+        const [page] = await Promise.all([
+            this._client.pages.read(filter, options)
+        ]);
+        return page;
+    }
+
+    async getSettings() {
+        const [settings] = await Promise.all([
+            this._client.settings.browse()
+        ]);
+        return settings;
+    }
+
+}
+
+export default async function GhostModule (ctx, inject) {
+    const client = new Ghost();
+    ctx.$ghost = client;
+    inject('ghost', client);
+}
diff --git a/package.json b/package.json
diff --git a/renovate.json b/renovate.json
diff --git a/test/module.test.js b/test/module.test.js
diff --git a/yarn.lock b/yarn.lock
