Merge pull request #87 from ossmini/develop

release: v1.0.2 배포

.github/workflows/sonar.yml

@@ -41,4 +41,5 @@ jobs:
           -Dsonar.scm.revision=${{ github.event.workflow_run.head_sha }}
           -Dsonar.pullrequest.key=${{ env.PR_NUMBER }}
           -Dsonar.pullrequest.branch=${{ env.HEAD_REF }}
-          -Dsonar.pullrequest.base=${{ env.BASE_REF }}
+          -Dsonar.pullrequest.base=${{ env.BASE_REF }}
+          -Dsonar.coverage.exclusions=**/Main.class,**/util/*.class,**/response/common/*.class

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[email protected].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -0,0 +1,30 @@
+# Contributing to Kakao I OpenBuilder Java Library
+Thank you for having an interest in contributing to Kakao I OpenBuilder Java Library!
+
+Not a developer? Submitting a bug report or giving your opinion about the project can help!
+
+## Creating an issue on Github
+Most of the issues are maintained in the issue section of the project's Github repository.
+
+You can open an issue [here](https://github.com/ossmini/Kakao_I_OpenBuilder_Library/issues).
+
+When opening an issue, please select a label from the list below.
+```
+- chore: Chores such as build.
+- docs: Make changes to documents.
+- feature: Request or add a feature.
+- fix: File a bug report or submit a fixed code.
+- question: Feel free to ask a question!
+- refactor: You can also refactor code.
+- test: Add a missing test code.
+```
+Please check [Opened issues](https://github.com/ossmini/Kakao_I_OpenBuilder_Library/issues?q=label%3Afix+is%3Aopen) before reporting a bug.
+
+
+## Creating a pull request
+Before starting a pull request, please create a corresponding issue on Github.
+
+1. Fork the project's [git repository](https://github.com/ossmini/Kakao_I_OpenBuilder_Library).
+2. Create a branch from 'develop' branch at your repo. The branch's name should be like 'label/issue-number'.
+3. Make changes!
+4. Open a pull request from your branch to upstream/develop.

README.md

@@ -1,2 +1,35 @@
-# Kakao_ChatBot_Library
-카카오 I 오픈빌더 챗봇 라이브러리 입니다.
+# Kakao I OpenBuilder Java Library
+[![example workflow](https://github.com/Sejong-OSS/Kakao_I_OpenBuilder_Library/actions/workflows/build.yml/badge.svg)](https://github.com/Sejong-OSS/Kakao_I_OpenBuilder_Library/actions/workflows/build.yml) [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=Sejong-OSS_Kakao_I_OpenBuilder_Library&metric=coverage)](https://sonarcloud.io/summary/new_code?id=Sejong-OSS_Kakao_I_OpenBuilder_Library) [![Bugs](https://sonarcloud.io/api/project_badges/measure?project=Sejong-OSS_Kakao_I_OpenBuilder_Library&metric=bugs)](https://sonarcloud.io/summary/new_code?id=Sejong-OSS_Kakao_I_OpenBuilder_Library) [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=Sejong-OSS_Kakao_I_OpenBuilder_Library&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=Sejong-OSS_Kakao_I_OpenBuilder_Library) [![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=Sejong-OSS_Kakao_I_OpenBuilder_Library&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=Sejong-OSS_Kakao_I_OpenBuilder_Library)
+
+## Getting Started
+### Maven
+```xml
+<dependency>
+  <groupId>dev.mini</groupId>
+  <artifactId>kakao-i-openbuilder</artifactId>
+  <version>1.0.0</version>
+</dependency>
+```
+### Gradle
+```groovy
+implementation 'dev.mini:kakao-i-openbuilder:1.0.1'
+```
+
+### Example
+There is an example code implementing this library, you can check it out over [here](https://github.com/ossmini/Kakao_ChatBot_Example).
+
+## Resources
+- [Kakao i Developers Docs](https://i.kakao.com/docs/getting-started-overview)
+
+## Contributing
+- [Submit bugs and feature requests](https://github.com/ossmini/Kakao_I_OpenBuilder_Library/issues)
+
+## License
+Licensed under the [Apache-2.0](https://github.com/ossmini/Kakao_I_OpenBuilder_Library/blob/main/LICENSE) license.
+## Development
+### Build
+You need [Apache Maven](http://maven.apache.org/) to build the project:
+
+```bash
+mvn clean install
+```

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>dev.mini</groupId>
     <artifactId>kakao-i-openbuilder</artifactId>
-    <version>1.0.1</version>
+    <version>1.0.2</version>
     <packaging>jar</packaging>
 
     <licenses>
@@ -31,21 +31,21 @@
     </developers>
 
     <scm>
-        <url>https://github.com/Sejong-OSS/Kakao_I_OpenBuilder_Library</url>
-        <connection>https://github.com/Sejong-OSS/Kakao_I_OpenBuilder_Library.git</connection>
-        <developerConnection>https://github.com/Sejong-OSS/Kakao_I_OpenBuilder_Library.git</developerConnection>
+        <url>https://github.com/ossmini/Kakao_I_OpenBuilder_Library</url>
+        <connection>https://github.com/ossmini/Kakao_I_OpenBuilder_Library.git</connection>
+        <developerConnection>https://github.com/ossmini/Kakao_I_OpenBuilder_Library.git</developerConnection>
     </scm>
 
     <issueManagement>
         <system>Github</system>
-        <url>https://github.com/Sejong-OSS/Kakao_I_OpenBuilder_Library/issues</url>
+        <url>https://github.com/ossmini/Kakao_I_OpenBuilder_Library/issues</url>
     </issueManagement>
 
     <description>Kakao I OpenBuilder Library is the unofficial Kakao chatbot library</description>
 
     <ciManagement>
         <system>Github Actions</system>
-        <url>https://github.com/Sejong-OSS/Kakao_I_OpenBuilder_Library/actions</url>
+        <url>https://github.com/ossmini/Kakao_I_OpenBuilder_Library/actions</url>
     </ciManagement>
 
     <properties>
@@ -63,7 +63,7 @@
         <repository>
             <id>github</id>
             <name>GitHub Packages</name>
-            <url>https://maven.pkg.github.com/Sejong-OSS/Kakao_I_OpenBuilder_Library</url>
+            <url>https://maven.pkg.github.com/ossmini/Kakao_I_OpenBuilder_Library</url>
         </repository>
     </distributionManagement>
 
@@ -101,6 +101,67 @@
                     </excludes>
                 </configuration>
             </plugin>
+
+            <plugin>
+                <groupId>org.jacoco</groupId>
+                <artifactId>jacoco-maven-plugin</artifactId>
+                <version>0.8.8</version>
+                <configuration>
+                    <formats>
+                        <format>XML</format>
+                        <format>HTML</format>
+                        <format>CSV</format>
+                    </formats>
+                    <excludes>
+                        <exclude>dev/mini/**/Main.class</exclude>
+                        <exclude>dev/mini/**/util/*.class</exclude>
+                        <exclude>dev/mini/**/response/common/*.class</exclude>
+                    </excludes>
+                </configuration>
+                <executions>
+                    <execution>
+                        <id>jacoco-prepare-agent</id>
+                        <goals>
+                            <goal>prepare-agent</goal>
+                        </goals>
+                    </execution>
+                    <execution>
+                        <id>jacoco-report</id>
+                        <goals>
+                            <goal>report</goal>
+                        </goals>
+                    </execution>
+                    <execution>
+                        <id>jacoco-check</id>
+                        <goals>
+                            <goal>check</goal>
+                        </goals>
+                        <configuration>
+                            <rules>
+                                <rule>
+                                    <element>BUNDLE</element>
+                                    <limits>
+                                        <limit>
+                                            <counter>INSTRUCTION</counter>
+                                            <value>COVEREDRATIO</value>
+                                            <minimum>0.70</minimum>
+                                        </limit>
+                                    </limits>
+                                    <element>METHOD</element>
+                                    <limits>
+                                        <limit>
+                                            <counter>LINE</counter>
+                                            <value>TOTALCOUNT</value>
+                                            <maximum>80</maximum>
+                                        </limit>
+                                    </limits>
+                                </rule>
+                            </rules>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
+
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-jar-plugin</artifactId>
@@ -116,6 +177,7 @@
                     </archive>
                 </configuration>
             </plugin>
+
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-assembly-plugin</artifactId>

src/main/java/dev/mini/kakaoiopenbuilder/skill/Main.java

@@ -1,8 +1,35 @@
 package dev.mini.kakaoiopenbuilder.skill;
 
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import dev.mini.kakaoiopenbuilder.skill.response.SKillResponseBuilder;
+import dev.mini.kakaoiopenbuilder.skill.response.SkillResponse;
+
+import java.util.HashMap;
+import java.util.Map;
+import java.util.logging.Logger;
+
 public class Main {
-    public static void main(String[] args) {
-        System.out.println("Hello Kakao I OpenBuilder Java Library!");
+    private static final Logger log = Logger.getLogger(Main.class.getName());
+    private static final ObjectMapper objectMapper = new ObjectMapper();
+
+    public static void main(String[] args) throws JsonProcessingException {
+        log.info("Hello Kakao I OpenBuilder Java Library!");
+
+        // example: SkillResponse Data
+        Map<String, String> dataMap = new HashMap<>();
+        dataMap.put("name","Ryan");
+        dataMap.put("position","Senior Managing Director");
+
+        SkillResponse skillResponse = SKillResponseBuilder.builder()
+                .addData("msg","HI")
+                .addData(dataMap)
+                .build();
+
+        String json = objectMapper.writeValueAsString(skillResponse);
+
+        log.info("Skill Response Data example");
+        log.info(json);
     }
 
 }

src/main/java/dev/mini/kakaoiopenbuilder/skill/exception/ComponentsOutOfBoundsException.java

@@ -0,0 +1,11 @@
+package dev.mini.kakaoiopenbuilder.skill.exception;
+
+public class ComponentsOutOfBoundsException extends IndexOutOfBoundsException {
+
+    private static final String MESSAGE = "출력할 수 있는 Skill Component의 개수는 1개 이상 3개 이하입니다.";
+
+    public ComponentsOutOfBoundsException() {
+        super(MESSAGE);
+    }
+
+}