WIP: Headless Commerce Plugin Implementation

headless-commerce/README.adoc

@@ -0,0 +1,3 @@
+
+The files in this directory are used as templates for the ant create-component target, +
+please do not modify them without understanding the effect that it will have on that build target.

headless-commerce/api/headless-commerce.rest.xml

@@ -0,0 +1,43 @@
+<api description="Customers API" displayName="Customers API" name="CustomersAPI" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="rest-api.xsd">
+  <resource description="" displayName="" enabled="true" name="Customers Resource" path="/hcv1/customers">
+    <operation verb="post" description="Creates Customer">
+      <service name="createCustomer"/>
+    </operation>
+    <operation verb="get" path="/{customerPartyId}/" description="Retrieves customer profile">
+      <service name="getCustomer"/>
+    </operation>
+    <operation verb="put" path="/{customerPartyId}" description="Updates customer's personal information">
+      <service name="updatePerson"/>
+    </operation>
+    <operation verb="get" path="/{customerPartyId}/shipping-addresses" description="Retrieves shipping addresses">
+      <service name="getCustomerPostalAddress"/>
+    </operation>
+    <operation verb="post" path="/{customerPartyId}/shipping-addresses" description="Creates shipping address">
+      <service name="createCustomerPostalAddress"/>
+    </operation>
+    <operation verb="put" path="/{customerPartyId}/shipping-addresses/{contactMechId}" description="Updates shipping address">
+      <service name="updateCustomerPostalAddress"/>
+    </operation>
+    <operation verb="post" path="/{customerPartyId}/change-password" description="Changes customer's account password">
+      <service name="changePassword"/>
+    </operation>
+    <operation verb="post" path="/reset-password" description="Sends reset password mail">
+      <service name="sendResetPasswordEmail"/>
+    </operation>
+    <operation verb="delete" path="/{customerPartyId}/shipping-addresses/{contactMechId}" description="Expires shipping address">
+      <service name="removeCustomerContactMech"/>
+    </operation>
+    <operation verb="get" path="/{customerPartyId}/payment-methods" description="Get payment methods(credit card, gift card, eft account)">
+      <service name="getPartyPaymentMethods"/>
+    </operation>
+    <operation verb="post" path="/{customerPartyId}/payment-methods" description="Creates payment method(credit card, gift card, eft account)">
+      <service name="createCustomerPaymentMethod"/>
+    </operation>
+    <operation verb="put" path="/{customerPartyId}/payment-methods/{paymentMethodId}" description="Updates payment method(credit card, gift card, eft account)">
+      <service name="updateCustomerPaymentMethod"/>
+    </operation>
+    <operation verb="delete" path="/{customerPartyId}/payment-methods/{paymentMethodId}" description="Deletes payment method(credit card, gift card, eft account)">
+      <service name="deleteCustomerPaymentMethod"/>
+    </operation>
+  </resource>
+</api>

headless-commerce/build.gradle

@@ -0,0 +1,37 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+dependencies {
+    //Examples of compile-time and runtime dependencies
+
+    //pluginLibsCompile 'junit:junit-dep:4.10'
+    //pluginLibsRuntime 'junit:junit-dep:4.10'
+}
+
+task install {
+    doLast {
+        // Install logic for this plugin
+    }
+}
+
+task uninstall {
+    doLast {
+        // uninstall logic for this plugin
+    }
+}

headless-commerce/config/HeadlessCommerceUiLabels.xml

@@ -0,0 +1,52 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements.  See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership.  The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License.  You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied.  See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+<resource xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://ofbiz.apache.org/dtds/ofbiz-properties.xsd">
+    <property key="HeadlessCommerceApplication">
+        <value xml:lang="en">HeadlessCommerce Application</value>
+        <value xml:lang="zh">HeadlessCommerce应用程序</value>
+        <value xml:lang="zh-TW">HeadlessCommerce應用程式</value>
+    </property>
+    <property key="HeadlessCommerceCompanyName">
+        <value xml:lang="en">OFBiz: HeadlessCommerce</value>
+        <value xml:lang="zh-TW">OFBiz: HeadlessCommerce</value>
+    </property>
+    <property key="HeadlessCommerceCompanySubtitle">
+        <value xml:lang="en">Part of the Apache OFBiz Family of Open Source Software</value>
+        <value xml:lang="it">Un modulo della famiglia di software open source Apache OFBiz</value>
+        <value xml:lang="zh">开源软件OFBiz的组成部分</value>
+        <value xml:lang="zh-TW">開源軟體OFBiz的組成部分</value>
+    </property>
+    <property key="HeadlessCommerceViewPermissionError">
+        <value xml:lang="en">You are not allowed to view this page.</value>
+        <value xml:lang="zh">不允许你浏览这个页面。</value>
+        <value xml:lang="zh-TW">不允許您檢視這個頁面.</value>
+    </property>
+    <property key="HCCountrysStateIsNotValid">
+        <value xml:lang="en">State [${stateCode}] does not in country [${countryCode}]</value>
+    </property>
+    <property key="HCInvalidCountryCode">
+        <value xml:lang="en">Invalid country [${countryCode}]</value>
+    </property>
+    <property key="HCAccessDeniedInvalidUser">
+        <value xml:lang="en">Access denied. Invalid user.</value>
+    </property>
+</resource>
+

headless-commerce/data/HeadlessCommerceDemoData.xml

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements.  See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership.  The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License.  You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied.  See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+<entity-engine-xml>
+
+</entity-engine-xml>

headless-commerce/data/HeadlessCommerceSecurityGroupDemoData.xml

@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements.  See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership.  The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License.  You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied.  See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+<entity-engine-xml>
+    <SecurityGroupPermission fromDate="2001-05-13 12:00:00.0" groupId="FULLADMIN" permissionId="HEADLESS_COMMERCE_ADMIN"/>
+    <SecurityGroupPermission fromDate="2001-05-13 12:00:00.0" groupId="FLEXADMIN" permissionId="HEADLESS_COMMERCE_CREATE"/>
+    <SecurityGroupPermission fromDate="2001-05-13 12:00:00.0" groupId="FLEXADMIN" permissionId="HEADLESS_COMMERCE_DELETE"/>
+    <SecurityGroupPermission fromDate="2001-05-13 12:00:00.0" groupId="FLEXADMIN" permissionId="HEADLESS_COMMERCE_UPDATE"/>
+    <SecurityGroupPermission fromDate="2001-05-13 12:00:00.0" groupId="FLEXADMIN" permissionId="HEADLESS_COMMERCE_VIEW"/>
+    <SecurityGroupPermission fromDate="2001-05-13 12:00:00.0" groupId="VIEWADMIN" permissionId="HEADLESS_COMMERCE_VIEW"/>
+    <SecurityGroupPermission fromDate="2001-05-13 12:00:00.0" groupId="BIZADMIN" permissionId="HEADLESS_COMMERCE_ADMIN"/>
+</entity-engine-xml>

headless-commerce/data/HeadlessCommerceSecurityPermissionSeedData.xml

@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements.  See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership.  The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License.  You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied.  See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+<entity-engine-xml>
+    <SecurityPermission description="View operations in the HeadlessCommerce Component." permissionId="HEADLESS_COMMERCE_VIEW"/>
+    <SecurityPermission description="Create operations in the HeadlessCommerce Component." permissionId="HEADLESS_COMMERCE_CREATE"/>
+    <SecurityPermission description="Update operations in the HeadlessCommerce Component." permissionId="HEADLESS_COMMERCE_UPDATE"/>
+    <SecurityPermission description="Delete operations in the HeadlessCommerce Component." permissionId="HEADLESS_COMMERCE_DELETE"/>
+    <SecurityPermission description="ALL operations in the HeadlessCommerce Component." permissionId="HEADLESS_COMMERCE_ADMIN"/>
+
+    <SecurityGroupPermission fromDate="2001-05-13 12:00:00.0" groupId="SUPER" permissionId="HEADLESS_COMMERCE_ADMIN"/>
+
+</entity-engine-xml>

headless-commerce/data/HeadlessCommerceTypeData.xml

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements.  See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership.  The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License.  You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied.  See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+<entity-engine-xml>
+
+</entity-engine-xml>

headless-commerce/entitydef/entitymodel.xml

@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements.  See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership.  The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License.  You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied.  See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+<entitymodel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:noNamespaceSchemaLocation="http://ofbiz.apache.org/dtds/entitymodel.xsd">
+    <!-- ========================================================= -->
+    <!-- ======================== Defaults ======================= -->
+    <!-- ========================================================= -->
+    <title>Entity of HeadlessCommerce Component</title>
+    <description>None</description>
+    <copyright></copyright>
+    <version></version>
+
+</entitymodel>

headless-commerce/ofbiz-component.xml

@@ -0,0 +1,53 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements.  See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership.  The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License.  You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied.  See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+<ofbiz-component name="headless-commerce"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:noNamespaceSchemaLocation="http://ofbiz.apache.org/dtds/ofbiz-component.xsd">
+    <!-- define resource loaders; most common is to use the component resource loader -->
+    <resource-loader name="main" type="component"/>
+
+    <!-- place the config directory on the classpath to access configuration files -->
+    <classpath type="dir" location="config"/>
+    <!-- entity resources: model(s), eca(s), group, and data definitions -->
+    <entity-resource type="model" reader-name="main" loader="main" location="entitydef/entitymodel.xml"/>
+    <!-- <entity-resource type="eca" reader-name="main" loader="main" location="entitydef/eecas.xml"/> -->
+    <entity-resource type="data" reader-name="seed" loader="main" location="data/HeadlessCommerceTypeData.xml"/>
+    <entity-resource type="data" reader-name="seed" loader="main" location="data/HeadlessCommerceSecurityPermissionSeedData.xml"/>
+    <entity-resource type="data" reader-name="demo" loader="main" location="data/HeadlessCommerceSecurityGroupDemoData.xml"/>
+    <entity-resource type="data" reader-name="demo" loader="main" location="data/HeadlessCommerceDemoData.xml"/>
+
+    <!-- service resources: model(s), eca(s) and group definitions -->
+    <service-resource type="model" loader="main" location="servicedef/services.xml"/>
+    <!--
+    <service-resource type="eca" loader="main" location="servicedef/secas.xml"/>
+    <service-resource type="group" loader="main" location="servicedef/groups.xml"/>
+    -->
+
+    <test-suite loader="main" location="testdef/HeadlessCommerceTests.xml"/>
+
+    <!-- web applications; will be mounted when using the embedded container -->
+    <webapp name="headless-commerce"
+        title="HeadlessCommerce"
+        server="default-server"
+        location="webapp/headless-commerce"
+        base-permission="OFBTOOLS,HEADLESS_COMMERCE"
+        mount-point="/headless-commerce"/>
+</ofbiz-component>