Skip to content

Latest commit

 

History

History
876 lines (707 loc) · 21.2 KB

README.md

File metadata and controls

876 lines (707 loc) · 21.2 KB
Raw

node-poeditor

This module is designed to connect the api from the POEditor Service. You can use the module in your own code as well with the CLI.

Getting Started

Install the module via npm

npm i --save --save-exact node-poeditor

When you like to use the CLI:

npm i --save --save-exact -g node-poeditor

Then it's possible to call all methods with the poeditor command.

CLI Arguments

Optional arguments:
  -h, --help            Show this help message and exit.
  -v, --version         Show program's version number and exit.
  -t TOKEN, --token TOKEN
                        Set the token to access the PO Editor API. You can
                        define it in your account-settings of PO Editor
  -c CONTEXT, --context CONTEXT
                        Set the context where you like to access. Available
                        contexts are: contributors, languages, projects and
                        terms
  -m METHOD, --method METHOD
                        Set the method where you like to access by the
                        defined context. See API Specs: https://github.
                        com/mwiesmueller/node-poeditor
  -id PROJECTID, --projectid PROJECTID
                        Define a projectid when its present in the context
  -d DESCRIPTION, --description DESCRIPTION
                        Set a description when its present in the context.
  -n NAME, --name NAME  Set a name when its present in the context.
  -o OBJECT, --object OBJECT
                        Set a object when its present in the context.
                        Attention: Set the Object as String!
  -out OUTFILE, --outFile OUTFILE
                        Define the file and path where the result will be
                        write
  -daf DATAFILE, --dataFile DATAFILE
                        Define a JSON Data file for data. This argument will
                        disable the --data argument!
  -da DATA, --data DATA
                        Set a data object when its present in the object!
  -l LANG, --lang LANG  Set a languagecode when its present in the context
  -e EMAIL, --email EMAIL
                        Set a email address (Only for contributors method)
  -a ADMIN, --admin ADMIN
                        Set it "1" when you like to set a admin. (Only for
                        contributors method)

Requirements

Install Node v8 at least since this module works with async await.

Use module in your project

To use this module in your project it's necessary to require the module:

const poconnect = require('node-poeditor');

Use API Calls:

Projects

• list

=> (Click hier to see the api docs)
const poconnect = require('node-poeditor');
const token = 'abcdef';

(async () => {
  try {
    const res = await poconnect.projects.list(token);

    // res => { projects: [] };
  } catch (err) {
    // err => returns an error when failed
  }
})();

This function will response all projects by your access token from the api and check if the project name alredy exist. Is it true, the function rejects an error.

Running by CLI Command:
poeditor -t <YourAPIKey> -c projects -m list

• view

=> (Click hier to see the api docs)
const poconnect = require('node-poeditor');
const token = 'abcdef';
const id = 12345;  // <= The unique identifier of the project. It's possible to get over function `list`.

(async () => {
  try {
    const res = await poconnect.projects.view(token, id);

    // res => {  "project": {
            "id": 7717,
            "name": "Automobile",
            "description": "",
            "public": 0,
            "open": 0,
            "reference_language": "",
            "terms": 0,
            "created": "2014-08-13T09:39:32+0000"
        }
      };
  } catch (err) {
    // err => returns an error when failed
  }
})();
Running by CLI Command:
poeditor -t <YourAPIKey> -c projects -m view -id <ProjectID>

• add

=> (Click hier to see the api docs)
const poconnect = require('node-poeditor');
const name = 'MyProjectName';
const description = 'Some description to the project';
const token = 'abcdef';

(async () => {
  try {
    const res = await poconnect.projects.add(token, name, description);

    // res => {  "project": {
            "id": 7717,
            "name": "Automobile",
            "description": "",
            "public": 0,
            "open": 0,
            "reference_language": "",
            "terms": 0,
            "created": "2014-08-13T09:39:32+0000"
        }
      };
  } catch (err) {
    // err => returns an error when failed
  }
})();
Running by CLI Command:
poeditor -t <YourAPIKey> -c projects -m add -n 'Fine Project' -d 'Iam a description'

• update

=> (Click hier to see the api docs)
const poconnect = require('node-poeditor');

const name = 'Projectname'; // A new name for your project
const description = 'Description'; // A new description for your project
const refLang = 'en'; // Set a new reference_language in your project

const token = 'abcdef';
const id = 12345; // <= The unique identifier of your project.

(async () => {
  try {
    const res = await poconnect.projects.update(token, id, { name, description, refLang });

    // res => {  "project": {
            "id": 7717,
            "name": "Automobile",
            "description": "",
            "public": 0,
            "open": 0,
            "reference_language": "",
            "terms": 0,
            "created": "2014-08-13T09:39:32+0000"
        }
      };
  } catch (err) {
    // err => returns an error when failed
  }
})();
Running by CLI Command:
poeditor -t <YourAPIKey> -c projects -m update -id <YourProjectID> -n 'Fine Project name update' -d 'Iam a new description'

• delete

=> (Click hier to see the api docs)
const poconnect = require('node-poeditor');
const token = 'abcdef';
const id = '1234';

(async () => {
  try {
    const res = await poconnect.projects.delete(token, id);

    // res => true;
  } catch (err) {
    // err => returns an error when failed
  }
})();
Running by CLI Command:
poeditor -t <YourAPIKey> -id <YourProjectID> -c projects -m delete

• sync

=> (Click hier to see the api docs)
const poconnect = require('node-poeditor');
const token = 'abcdef';
const id = '1234';

const terms = [
 { term: 'I am a test term',
   context: 'TestContext',
   reference: 'Tests',
   plural: 'I am some test terms',
   comment: 'Some comment'
 },
 { term: 'Today is a nice day',
   context: 'Outside of the office',
   reference: 'Have Fun',
   plural: 'I have nice days whole the year :-)',
   comment: 'A comment again'
 }
];

(async () => {
  try {
    const res = await poconnect.projects.sync(token, id, terms);

    // res => "result": {
        "terms": {
            "parsed": 2,
            "added": 2,
            "updated": 0,
            "deleted": 2446
        }
    };
  } catch (err) {
    // err => returns an error when failed
  }
})();

With this method it's possible to sync your terms in your project.

Running by CLI Command:
poeditor -t <YourAPIKey> -id <YourProjectID> -c projects -m sync -daf <YourDataFilePath>

• export

=> (Click hier to see the api docs)
const poconnect = require('node-poeditor');
const token = 'abcdef';
const id = '1234';
const obj = {
  language: 'de', // Define the language which you like to export
  type: 'json', // Define the export type. Please read the options in the API documentation
  tags: '["tag"]', //  Define your tags
  filters: '["filters"] // Define your filters'
};

(async () => {
  try {
    const res = await poconnect.projects.export(token, id, obj);

    // res => "result": {
        "url": "https:\/\/api.poeditor.com\/v2\/download\/file\/b577a66ac39d82995debfabc016f855d"
    };
  } catch (err) {
    // err => returns an error when failed
  }
})();

With this method it's possible to export your projects in your favorite language.

Languages

• available

=> (Click hier to see the api docs)
const poconnect = require('node-poeditor');
const token = 'abcdef';

(async () => {
  try {
    const res = await poconnect.languages.available(token);

    // res => { "languages": [
            {
                "name": "Abkhazian",
                "code": "ab"
            },
            {
                "name": "Afar",
                "code": "aa"
            },
            {
                "name": "Afrikaans",
                "code": "af"
            },
            {
                "name": "Akan",
                "code": "ak"
            },
            {
                "name": "Albanian",
                "code": "sq"
            },
            {
                "name": "Amharic",
                "code": "am"
            },
            {
                "name": "Arabic",
                "code": "ar"
            },
            .
            .
            .
            .
            .
   };
  } catch (err) {
    // err => returns an error when failed
  }
})();
Running by CLI Command:
poeditor -t <YourAPIKey> -c languages -m available

• list

=> (Click hier to see the api docs)
const poconnect = require('node-poeditor');
const token = 'abcdef';
const id = 1234;

(async () => {
  try {
    const res = await poconnect.languages.list(token, id);

    // res => { "languages": [
            {
                "name": "English",
                "code": "en",
                "translations": 13,
                "percentage": 12.5,
                "updated": "2015-05-04T14:21:41+0000"
            },
            {
                "name": "French",
                "code": "fr",
                "translations": 70,
                "percentage": 68.75,
                "updated": "2015-04-30T08:59:34+0000"
            }
        ]
   };
  } catch (err) {
    // err => returns an error when failed
  }
})();
Running by CLI Command:
poeditor -t <YourAPIKey> -c languages -m list -id <YourProjectID>

• add

=> (Click hier to see the api docs)
const poconnect = require('node-poeditor');
const token = 'abcdef';
const id = 1234;
const lang = 'de'

(async () => {
  try {
    const res = await poconnect.languages.add(token, id, lang);

    // res => true;
  } catch (err) {
    // err => returns an error when failed
  }
})();

With this method it's possible to add a additional language to an exist project. You cann fetch the languagecodes over the method list

Running by CLI Command:
poeditor -t <YourAPIKey> -c languages -m add -id <YourProjectID> -l <YourLanguageCode>

• delete

=> (Click hier to see the api docs)
const poconnect = require('node-poeditor');
const token = 'abcdef';
const id = 1234;
const lang = 'de'

(async () => {
  try {
    const res = await poconnect.languages.delete(token, id, lang);

    // res => true;
  } catch (err) {
    // err => returns an error when failed
  }
})();

With this function it's possible to delete an language by project.

Running by CLI Command:
poeditor -t <YourAPIKey> -c languages -m delete -id <YourProjectID> -l <YourLanguageCode>

Terms

• list

=> (Click hier to see the api docs)
const poconnect = require('node-poeditor');
const token = 'abcdef';
const id = 1234;

(async () => {
  try {
    const res = await poconnect.terms.list(token, id);

    // res => { "terms": [
            {
                "term": "app_name",
                "context": "",
                "plural": "",
                "created": "2013-06-10T11:08:54+0000",
                "updated": "",
                "translation": {
                    "content": "TODO List",
                    "fuzzy": 0,
                    "proofread": 1,
                    "updated": "2013-06-12T11:08:54+0000"
                },
                "reference": "",
                "tags": [
                    "first_upload",
                    "second_upload"
                ],
                "comment": "Don't translate the name of the app"
            },
            {
                "term": "mark_as_unread",
                "context": "",
                "plural": "",
                "created": "2013-06-10T11:08:54+0000",
                "updated": "",
                "translation": {
                    "content": "",
                    "fuzzy": 0,
                    "proofread": 0,
                    "updated": ""
                },
                "reference": "",
                "tags": [
                    "second_upload"
                ],
                "comment": ""
            },
            {
                "term": "One Item",
                "context": "",
                "plural": "%d Items",
                "created": "2013-06-10T11:24:12+0000",
                "updated": "",
                "translation": {
                    "content": {
                        "one": "",
                        "other": ""
                    },
                    "fuzzy": 0,
                    "proofread": 0,
                    "updated": ""
                },
                "reference": "",
                "tags": [],
                "comment": ""
            }
        ]
   };
  } catch (err) {
    // err => returns an error when failed
  }
})();
Running by CLI Command:
poeditor -t <YourAPIKey> -c terms -m list -id <YourProjectID>

• add

=> (Click hier to see the api docs)
const poconnect = require('node-poeditor');
const token = 'abcdef';
const id = 1234;
const terms = [
    {
        "term": "Add new list",
        "context": "",
        "reference": "\/projects",
        "plural": "",
        "comment": ""
    },
    {
        "term": "one project found",
        "context": "",
        "reference": "\/projects",
        "plural": "%d projects found",
        "comment": "Make sure you translate the plural forms",
        "tags": [
            "first_tag",
            "second_tag"
        ]
    },
    {
        "term": "Show all projects",
        "context": "",
        "reference": "\/projects",
        "plural": "",
        "tags": "just_a_tag"
    }
];

(async () => {
  try {
    const res = await poconnect.terms.add(token, id, terms);

    // res => {
        "terms": {
            "parsed": 1,
            "added": 1
        };
  } catch (err) {
    // err => returns an error when failed
  }
})();
Running by CLI Command:
poeditor -t <YourAPIKey> -c terms -m add -id <YourProjectID> -daf <YourDataFilePath>

• update

=> (Click hier to see the api docs)
const poconnect = require('node-poeditor');
const token = 'abcdef';
const id = 1234;
const terms = [
    {
        "term": "Add new list",
        "context": "",
        "reference": "\/projects",
        "plural": "",
        "comment": ""
    },
    {
        "term": "one project found",
        "context": "",
        "reference": "\/projects",
        "plural": "%d projects found",
        "comment": "Make sure you translate the plural forms",
        "tags": [
            "first_tag",
            "second_tag"
        ]
    },
    {
        "term": "Show all projects",
        "context": "",
        "reference": "\/projects",
        "plural": "",
        "tags": "just_a_tag"
    }
];

(async () => {
  try {
    const res = await poconnect.terms.update(token, id, terms);

    // res => {
        "terms": {
            "parsed": 1,
            "updated": 1
        };
  } catch (err) {
    // err => returns an error when failed
  }
})();
Running by CLI Command:
poeditor -t <YourAPIKey> -c terms -m update -id <YourProjectID> -daf <YourDataFilePath>

• delete

=> (Click hier to see the api docs)
const poconnect = require('node-poeditor');
const token = 'abcdef';
const id = 1234;
const terms = [
    {
        "term": "Add new list",
        "context": "",
        "reference": "\/projects",
        "plural": "",
        "comment": ""
    },
    {
        "term": "one project found",
        "context": "",
        "reference": "\/projects",
        "plural": "%d projects found",
        "comment": "Make sure you translate the plural forms",
        "tags": [
            "first_tag",
            "second_tag"
        ]
    },
    {
        "term": "Show all projects",
        "context": "",
        "reference": "\/projects",
        "plural": "",
        "tags": "just_a_tag"
    }
];

(async () => {
  try {
    const res = await poconnect.terms.delete(token, id, terms);

    // res => {
        "terms": {
            "parsed": 2,
            "deleted": 2
        };
  } catch (err) {
    // err => returns an error when failed
  }
})();
Running by CLI Command:
poeditor -t <YourAPIKey> -c terms -m delete -id <YourProjectID> -daf <YourDataFilePath>

Contributors

• list

=> (Click hier to see the api docs)
const poconnect = require('node-poeditor');
const token = 'abcdef';
const id = 1234;
const lang = 'de'; // Optional

(async () => {
  try {
    const res = await poconnect.contributors.list(token, id, lang);

    // res => { "contributors": [
            {
                "name": "final test",
                "email": "[email protected]",
                "permissions": [
                    {
                        "project": {
                            "id": "4886",
                            "name": "Twentytwelve"
                        },
                        "type": "administrator"
                    }
                ]
            }
        ]};
  } catch (err) {
    // err => returns an error when failed
  }
})();
Running by CLI Command:
poeditor -t <YourAPIKey> -c contributors -m list -id <YourProjectID> -l de

• add

=> (Click hier to see the api docs)
const poconnect = require('node-poeditor');
const token = 'abcdef';
const id = 1234;
cosnt obj = {
  name: 'Mister cool',  // Required: Set the name of the contributor
  email: '[email protected]', // Required: Set the email of the contributor
  language: 'de', // Set the language for the contributor
  admin: '1' // Set it to `1` when you like that the contributor is an administrator
}

(async () => {
  try {
    const res = await poconnect.contributors.add(token, id);

    // res => true;
  } catch (err) {
    // err => returns an error when failed
  }
})();
Running by CLI Command:
poeditor -t <YourAPIKey> -c contributors -m add -id <YourProjectID> -n 'Martin' -e  '[email protected]' -admin 1 -l de

• remove

=> (Click hier to see the api docs)
const poconnect = require('node-poeditor');
const token = 'abcdef';
const id = 1234;
cosnt obj = {
  email: '[email protected]', // Required: Set the email of the contributor
  language: 'en'
}

(async () => {
  try {
    const res = await poconnect.contributors.remove(token, id);

    // res => res => true;
  } catch (err) {
    // err => returns an error when failed
  }
})();
Running by CLI Command:
poeditor -t <YourAPIKey> -c contributors -m remove -id <YourProjectID> -e '[email protected]' -l de

Development Information

When you like to fork this module, you must set some ENV Variables to running the tests.

Running tests:

API_TOKEN=<your API Token> TEST_EMAIL=<your emailaddress to test> gulp test

License

The MIT License (MIT) Copyright (c) 2017 Martin Wiesmüller - WERBAS AG / Werbas Innotec GmbH.

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.