From cd23ece924706c680be24d989fa959eb44c8c957 Mon Sep 17 00:00:00 2001
From: mcilwain <mcilwain@google.com>
Date: Mon, 11 Jul 2016 08:27:41 -0700
Subject: [PATCH] Rename TldSpecificLogicEngine to TldSpecificLogicProxy

This new name is a more accurate description of what the actual class
does.  TldSpecificLogicEngine is an interface that will be added in
the near future, implementations of which will provide custom per-TLD
logic.  The class being renamed is more properly a proxy that only
handles logic generic to all TLDs.
-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=127088913
---
 .../flows/domain/BaseDomainCreateFlow.java    |   6 +-
 .../flows/domain/DomainFlowUtils.java         |  10 +-
 ...Engine.java => TldSpecificLogicProxy.java} |   8 +-
 .../pricing/TldSpecificLogicProxyTest.java    | 107 ++++++++++++++++++
 4 files changed, 119 insertions(+), 12 deletions(-)
 rename java/google/registry/pricing/{TldSpecificLogicEngine.java => TldSpecificLogicProxy.java} (95%)
 create mode 100644 javatests/google/registry/pricing/TldSpecificLogicProxyTest.java

diff --git a/java/google/registry/flows/domain/BaseDomainCreateFlow.java b/java/google/registry/flows/domain/BaseDomainCreateFlow.java
index b46b9323c..ad2928bed 100644
--- a/java/google/registry/flows/domain/BaseDomainCreateFlow.java
+++ b/java/google/registry/flows/domain/BaseDomainCreateFlow.java
@@ -65,8 +65,8 @@ import google.registry.model.registry.Registry;
 import google.registry.model.registry.Registry.TldState;
 import google.registry.model.smd.SignedMark;
 import google.registry.model.tmch.ClaimsListShard;
-import google.registry.pricing.TldSpecificLogicEngine;
-import google.registry.pricing.TldSpecificLogicEngine.EppCommandOperations;
+import google.registry.pricing.TldSpecificLogicProxy;
+import google.registry.pricing.TldSpecificLogicProxy.EppCommandOperations;
 
 import java.util.Set;
 
@@ -180,7 +180,7 @@ public abstract class BaseDomainCreateFlow<R extends DomainBase, B extends Build
     tldState = registry.getTldState(now);
     checkRegistryStateForTld(tld);
     domainLabel = domainName.parts().get(0);
-    commandOperations = TldSpecificLogicEngine.getCreatePrice(
+    commandOperations = TldSpecificLogicProxy.getCreatePrice(
         registry, domainName.toString(), now, command.getPeriod().getValue());
     // The TLD should always be the parent of the requested domain name.
     isAnchorTenantViaReservation = matchesAnchorTenantReservation(
diff --git a/java/google/registry/flows/domain/DomainFlowUtils.java b/java/google/registry/flows/domain/DomainFlowUtils.java
index 7eeff164e..1a82562f3 100644
--- a/java/google/registry/flows/domain/DomainFlowUtils.java
+++ b/java/google/registry/flows/domain/DomainFlowUtils.java
@@ -88,7 +88,7 @@ import google.registry.model.smd.AbstractSignedMark;
 import google.registry.model.smd.EncodedSignedMark;
 import google.registry.model.smd.SignedMark;
 import google.registry.model.smd.SignedMarkRevocationList;
-import google.registry.pricing.TldSpecificLogicEngine;
+import google.registry.pricing.TldSpecificLogicProxy;
 import google.registry.tmch.TmchXmlSignature;
 import google.registry.tmch.TmchXmlSignature.CertificateSignatureException;
 import google.registry.util.Idn;
@@ -580,7 +580,7 @@ public class DomainFlowUtils {
         .setCommand(feeCommand)
         .setCurrency(registry.getCurrency())
         .setPeriod(feeRequest.getPeriod())
-        .setClass(TldSpecificLogicEngine.getFeeClass(domainName, now).orNull());
+        .setClass(TldSpecificLogicProxy.getFeeClass(domainName, now).orNull());
 
     switch (feeCommand.getCommand()) {
       case UNKNOWN:
@@ -590,7 +590,7 @@ public class DomainFlowUtils {
           builder.setClass("reserved");  // Override whatever class we've set above.
         } else {
           builder.setFees(
-              TldSpecificLogicEngine.getCreatePrice(registry, domainName, now, years).getFees());
+              TldSpecificLogicProxy.getCreatePrice(registry, domainName, now, years).getFees());
         }
         break;
       case RESTORE:
@@ -598,12 +598,12 @@ public class DomainFlowUtils {
           throw new RestoresAreAlwaysForOneYearException();
         }
         builder.setFees(
-            TldSpecificLogicEngine.getRestorePrice(registry, domainName, now, years).getFees());
+            TldSpecificLogicProxy.getRestorePrice(registry, domainName, now, years).getFees());
         break;
       default:
         // Anything else (transfer|renew) will have a "renew" fee.
         builder.setFees(
-            TldSpecificLogicEngine.getRenewPrice(registry, domainName, now, years).getFees());
+            TldSpecificLogicProxy.getRenewPrice(registry, domainName, now, years).getFees());
     }
   }
 
diff --git a/java/google/registry/pricing/TldSpecificLogicEngine.java b/java/google/registry/pricing/TldSpecificLogicProxy.java
similarity index 95%
rename from java/google/registry/pricing/TldSpecificLogicEngine.java
rename to java/google/registry/pricing/TldSpecificLogicProxy.java
index 94f729156..3ffbf2984 100644
--- a/java/google/registry/pricing/TldSpecificLogicEngine.java
+++ b/java/google/registry/pricing/TldSpecificLogicProxy.java
@@ -33,10 +33,10 @@ import org.joda.money.Money;
 import org.joda.time.DateTime;
 
 /**
- * Provides specialized pricing, billing and update logic per TLD.  TODO: consider making these
- * methods of Registry.
+ * Provides pricing, billing, and update logic, with call-outs that can be customized by providing
+ * implementations on a per-TLD basis.
  */
-public final class TldSpecificLogicEngine {
+public final class TldSpecificLogicProxy {
 
   private static final String EAP_DESCRIPTION_FORMAT = "Early Access Period, fee expires: %s";
 
@@ -80,7 +80,7 @@ public final class TldSpecificLogicEngine {
     }
   }
 
-  private TldSpecificLogicEngine() {}
+  private TldSpecificLogicProxy() {}
 
   /**
    * Returns a new "create" price for the Pricer.
diff --git a/javatests/google/registry/pricing/TldSpecificLogicProxyTest.java b/javatests/google/registry/pricing/TldSpecificLogicProxyTest.java
new file mode 100644
index 000000000..0c1c448a8
--- /dev/null
+++ b/javatests/google/registry/pricing/TldSpecificLogicProxyTest.java
@@ -0,0 +1,107 @@
+// Copyright 2016 The Domain Registry Authors. All Rights Reserved.
+//
+// Licensed 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.
+
+package google.registry.pricing;
+
+import static com.google.common.truth.Truth.assertThat;
+import static google.registry.testing.DatastoreHelper.createTld;
+import static google.registry.testing.DatastoreHelper.persistResource;
+import static google.registry.util.DateTimeUtils.START_OF_TIME;
+import static org.joda.money.CurrencyUnit.USD;
+
+import com.google.common.collect.ImmutableList;
+import com.google.common.collect.ImmutableSortedMap;
+
+import google.registry.model.domain.fee.Fee;
+import google.registry.model.ofy.Ofy;
+import google.registry.model.registry.Registry;
+import google.registry.testing.AppEngineRule;
+import google.registry.testing.FakeClock;
+import google.registry.testing.InjectRule;
+
+import org.joda.money.Money;
+import org.joda.time.DateTime;
+import org.junit.Before;
+import org.junit.Rule;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.junit.runners.JUnit4;
+
+@RunWith(JUnit4.class)
+public class TldSpecificLogicProxyTest {
+
+  @Rule
+  public final InjectRule inject = new InjectRule();
+
+  @Rule
+  public final AppEngineRule appEngine = AppEngineRule.builder().withDatastore().build();
+
+  final FakeClock clock = new FakeClock(DateTime.parse("2010-01-01T10:00:00Z"));
+
+  Money basicCreateCost;
+
+  @Before
+  public void before() throws Exception {
+    inject.setStaticField(Ofy.class, "clock", clock);
+    createTld("tld");
+
+    createTld("eap");
+    DateTime a = clock.nowUtc().minusDays(1);
+    DateTime b = clock.nowUtc().plusDays(1);
+    persistResource(
+        Registry.get("eap")
+            .asBuilder()
+            .setEapFeeSchedule(
+                ImmutableSortedMap.of(
+                    START_OF_TIME, Money.of(USD, 0),
+                    a, Money.of(USD, 100),
+                    b, Money.of(USD, 50)))
+            .build());
+
+    basicCreateCost =
+        PricingEngineProxy.getPricesForDomainName("example.tld", clock.nowUtc()).getCreateCost();
+  }
+
+  @Test
+  public void testTldSpecificLogicEngine() {
+    TldSpecificLogicProxy.EppCommandOperations createPrice =
+        TldSpecificLogicProxy.getCreatePrice(
+            Registry.get("tld"), "example.tld", clock.nowUtc(), 1);
+    assertThat(createPrice.getTotalCost()).isEqualTo(basicCreateCost);
+    assertThat(createPrice.getFees()).hasSize(1);
+  }
+
+  @Test
+  public void testTldSpecificLogicEngineEap() {
+    TldSpecificLogicProxy.EppCommandOperations createPrice =
+        TldSpecificLogicProxy.getCreatePrice(
+            Registry.get("eap"), "example.eap", clock.nowUtc(), 1);
+    assertThat(createPrice.getTotalCost()).isEqualTo(basicCreateCost.plus(Money.of(USD, 100)));
+    assertThat(createPrice.getCurrency()).isEqualTo(USD);
+    assertThat(createPrice.getFees().get(0))
+        .isEqualTo(Fee.create(basicCreateCost.getAmount(), "create"));
+    assertThat(createPrice.getFees().get(1))
+        .isEqualTo(
+            Fee.create(
+                Money.of(USD, 100).getAmount(),
+                "Early Access Period, fee expires: " + clock.nowUtc().plusDays(1)));
+    assertThat(createPrice.getFees())
+        .isEqualTo(
+            ImmutableList.of(
+                Fee.create(basicCreateCost.getAmount(), "create"),
+                Fee.create(
+                    Money.of(USD, 100).getAmount(),
+                    "Early Access Period, fee expires: " + clock.nowUtc().plusDays(1))));
+  }
+}