Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix Plan and InputPlan fields #41

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
+132 −62
Open

Fix Plan and InputPlan fields #41

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
71b2b10
Fix Plan class to use nickname and product fields.
stewSquared Mar 19, 2018
0ae74cb
Update stripe plan docs
stewSquared Mar 20, 2018
10f5821
Add `Product` ADT for child `product` of Plan objects
stewSquared Mar 20, 2018
29dd366
Replace flat Plan product parameters with child object
stewSquared Mar 20, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
194 changes: 132 additions & 62 deletions src/main/scala/org/mdedetrich/stripe/v1/Plans.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import java.time.OffsetDateTime
import akka.http.scaladsl.HttpExt
import akka.http.scaladsl.model.Uri
import akka.stream.Materializer
import cats.syntax.either._
import com.typesafe.scalalogging.LazyLogging
import defaults._
import enumeratum._
Expand Down Expand Up @@ -53,18 +54,19 @@ object Plans extends LazyLogging {
/**
* @see https://stripe.com/docs/api#plan_object
* @param id
* @param amount The amount in cents to be charged on the interval specified
* @param amount The amount in cents to be charged on the interval specified.
* @param created
* @param currency Currency in which subscription will be charged
* @param interval One of [[Interval.Day]], [[Interval.Week]], [[Interval.Month]] or
* [[Interval.Year]]. The frequency with which a subscription
* should be billed.
* [[Interval.Year]]. The frequency with which a subscription should
* be billed.
* @param intervalCount The number of intervals (specified in the [[interval]]
* property) between each subscription billing. For example,
* \[[interval]]=[[Interval.Month]] and [[intervalCount]]=3
* bills every 3 months.
* @param livemode
* @param name Display name of the plan
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There was no name parameter for plan, but it's child object had a name parameter for the service product.

* @param nickname A brief description of the plan, hidden from customers.
* @param product The product whose pricing this plan determines (not expanded).
* @param metadata A set of key/value pairs that you can attach to a plan object.
* It can be useful for storing additional information about the
* plan in a structured format.
Expand All @@ -81,26 +83,28 @@ object Plans extends LazyLogging {
interval: Interval,
intervalCount: Long,
livemode: Boolean,
name: String,
nickname: Option[String],
product: String,
metadata: Option[Map[String, String]] = None,
statementDescriptor: Option[String] = None,
trialPeriodDays: Option[Long] = None)

implicit val planDecoder: Decoder[Plan] = Decoder.forProduct11(
implicit val planDecoder: Decoder[Plan] = Decoder.forProduct12(
"id",
"amount",
"created",
"currency",
"interval",
"interval_count",
"livemode",
"name",
"nickname",
"product",
"metadata",
"statement_descriptor",
"trial_period_days"
)(Plan.apply)

implicit val planEncoder: Encoder[Plan] = Encoder.forProduct12(
implicit val planEncoder: Encoder[Plan] = Encoder.forProduct13(
"id",
"object",
"amount",
Expand All @@ -109,7 +113,8 @@ object Plans extends LazyLogging {
"interval",
"interval_count",
"livemode",
"name",
"nickname",
"product",
"metadata",
"statement_descriptor",
"trial_period_days"
Expand All @@ -124,95 +129,149 @@ object Plans extends LazyLogging {
x.intervalCount,
x.livemode,
x.metadata,
x.name,
x.nickname,
x.product,
x.statementDescriptor,
x.trialPeriodDays))

sealed abstract class Product
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From the documentation:

product: The product whose pricing the created plan will represent. This can either be the ID of an existing product, or a dictionary containing fields used to create a service product.

The names for the two sub classes, ProductId and ServiceProduct from the names of the two italicized phrases, but I'm happy to shorten them if that would be more consistent with the rest of the names.


object Product {
import io.circe._
import io.circe.syntax._

case class ProductId(id: String) extends Product

/**
* @see https://stripe.com/docs/api#create_plan
* @param id The identifier for the product.
* Must be unique. If not provided, an identifier will be randomly
* generated.
* @param name The product’s name, meant to be displayable to the customer.
* @param metadata
* @param statementDescriptor An arbitrary string to be displayed on your
* customer’s credit card statement. This may be up to 22
* characters. As an example, if your website is RunClub and the
* item you’re charging for is your Silver Plan, you may want to
* specify a [[statementDescriptor]] of RunClub Silver Plan. The
* statement description may not include `<>"'` characters, and will
* appear on your customer’s statement in capital letters. Non-ASCII
* characters are automatically stripped. While most banks display
* this information consistently, some may display it incorrectly or
* not at all.
*
* @throws StatementDescriptorTooLong - If [[statementDescriptor]] is longer than 22 characters
* @throws StatementDescriptorInvalidCharacter - If [[statementDescriptor]] has an invalid character
*/
case class ServiceProduct(
id: Option[String],
name: String,
metadata: Option[Map[String, String]],
statementDescriptor: Option[String]
) extends Product {
statementDescriptor match {
case Some(sD) if sD.length > 22 =>
throw StatementDescriptorTooLong(sD.length)
case Some(sD) if sD.contains("<") =>
throw StatementDescriptorInvalidCharacter("<")
case Some(sD) if sD.contains(">") =>
throw StatementDescriptorInvalidCharacter(">")
case Some(sD) if sD.contains("\"") =>
throw StatementDescriptorInvalidCharacter("\"")
case Some(sD) if sD.contains("\'") =>
throw StatementDescriptorInvalidCharacter("\'")
case _ =>
}
}

implicit val planProductDecoder: Decoder[Product] = Decoder.instance[Product] { p =>
p.as[JsonObject] match {
case Left(_) =>
p.as[String].map(ProductId.apply)
case Right(_) =>
val decoder: Decoder[ServiceProduct] = Decoder.forProduct4(
"id",
"name",
"metadata",
"statement_descriptor"
)(ServiceProduct.apply)
decoder.apply(p)
}
}

implicit val planProductEncoder: Encoder[Product] = Encoder.instance[Product] {
case ProductId(id) => id.asJson
case service: ServiceProduct =>
val encoder: Encoder[ServiceProduct] = Encoder.forProduct4(
"id",
"name",
"metadata",
"statement_descriptor"
)(x => ServiceProduct.unapply(x).get)
encoder.apply(service)
}
}

/**
* @see https://stripe.com/docs/api#create_plan
* @param id Unique string of your choice that will be used
* to identify this plan when subscribing a customer.
* This could be an identifier like “gold” or a
* primary key from your own database.
* @param id An identifier randomly generated by Stripe.
* Used to identify this plan when subscribing a customer. You can
* optionally override this ID, but the ID must be unique across all
* plans in your Stripe account. You can, however, use the same plan
* ID in both live and test modes.
* @param amount A positive integer in cents (or 0 for a free plan)
* representing how much to charge (on a recurring basis).
* @param currency 3-letter ISO code for currency.
* @param interval Specifies billing frequency. Either [[Interval.Day]],
* [[Interval.Week]], [[Interval.Month]] or [[Interval.Year]].
* @param name Name of the plan, to be displayed on invoices and in
* the web interface.
* @param intervalCount The number of intervals between each subscription
* billing. For example, [[interval]]=[[Interval.Month]]
* and [[intervalCount]]=3 bills every 3 months. Maximum of
* one year interval allowed (1 year, 12 months, or 52 weeks).
* @param product The product whose pricing the created plan will represent.
* This can either be the ID of an existing product, or a dictionary
* containing fields used to create a service product.
* @param metadata A set of key/value pairs that you can attach to a plan object.
* It can be useful for storing additional information about
* the plan in a structured format. This will be unset if you
* POST an empty value.
* @param statementDescriptor An arbitrary string to be displayed on your
* customer’s credit card statement. This may be up to
* 22 characters. As an example, if your website is
* RunClub and the item you’re charging for is your
* Silver Plan, you may want to specify a [[statementDescriptor]]
* of RunClub Silver Plan. The statement description may not include `<>"'`
* characters, and will appear on your customer’s statement in
* capital letters. Non-ASCII characters are automatically stripped.
* While most banks display this information consistently,
* some may display it incorrectly or not at all.
* @param nickname A brief description of the plan, hidden from customers.
*
* @param trialPeriodDays Specifies a trial period in (an integer number of)
* days. If you include a trial period, the customer
* won’t be billed for the first time until the trial period ends.
* If the customer cancels before the trial period is over,
* she’ll never be billed at all.
* @throws StatementDescriptorTooLong - If [[statementDescriptor]] is longer than 22 characters
* @throws StatementDescriptorInvalidCharacter - If [[statementDescriptor]] has an invalid character
*/
case class PlanInput(id: String,
amount: BigDecimal,
currency: Currency,
interval: Interval,
name: String,
product: Product,
intervalCount: Option[Long] = None,
metadata: Option[Map[String, String]] = None,
statementDescriptor: Option[String] = None,
trialPeriodDays: Option[Long] = None) {
statementDescriptor match {
case Some(sD) if sD.length > 22 =>
throw StatementDescriptorTooLong(sD.length)
case Some(sD) if sD.contains("<") =>
throw StatementDescriptorInvalidCharacter("<")
case Some(sD) if sD.contains(">") =>
throw StatementDescriptorInvalidCharacter(">")
case Some(sD) if sD.contains("\"") =>
throw StatementDescriptorInvalidCharacter("\"")
case Some(sD) if sD.contains("\'") =>
throw StatementDescriptorInvalidCharacter("\'")
case _ =>
}
}
nickname: Option[String] = None)

implicit val planInputDecoder: Decoder[PlanInput] = Decoder.forProduct9(
implicit val planInputDecoder: Decoder[PlanInput] = Decoder.forProduct8(
"id",
"amount",
"currency",
"interval",
"name",
"product",
"interval_count",
"metadata",
"statement_descriptor",
"trial_period_days"
"nickname"
)(PlanInput.apply)

implicit val planInputEncoder: Encoder[PlanInput] = Encoder.forProduct9(
implicit val planInputEncoder: Encoder[PlanInput] = Encoder.forProduct8(
"id",
"amount",
"currency",
"interval",
"name",
"product",
"interval_count",
"metadata",
"statement_descriptor",
"trial_period_days"
"nickname"
)(x => PlanInput.unapply(x).get)

def create(planInput: PlanInput)(idempotencyKey: Option[IdempotencyKey] = None)(
Expand All @@ -223,15 +282,26 @@ object Plans extends LazyLogging {
executionContext: ExecutionContext): Future[Try[Plan]] = {
val postFormParameters = PostParams.flatten(
Map(
"id" -> Option(planInput.id.toString),
"amount" -> Option(planInput.amount.toString()),
"currency" -> Option(planInput.currency.iso.toLowerCase),
"interval" -> Option(planInput.interval.id.toString),
"name" -> Option(planInput.name),
"interval_count" -> planInput.intervalCount.map(_.toString),
"statement_descriptor" -> planInput.statementDescriptor,
"trial_period_days" -> planInput.trialPeriodDays.map(_.toString)
)) ++ mapToPostParams(planInput.metadata, "metadata")
"id" -> Option(planInput.id.toString),
"amount" -> Option(planInput.amount.toString()),
"currency" -> Option(planInput.currency.iso.toLowerCase),
"interval" -> Option(planInput.interval.id.toString),
"interval_count" -> planInput.intervalCount.map(_.toString),
"nickname" -> planInput.nickname
)) ++ mapToPostParams(planInput.metadata, "metadata") ++ {
planInput.product match {
case service: Product.ServiceProduct =>
val params = PostParams.flatten(
Map(
"id" -> service.id,
"name" -> Option(service.name),
"statement_descriptor" -> service.statementDescriptor
)
)
mapToPostParams(Option(params ++ mapToPostParams(service.metadata, "metadata")), "product")
Copy link
Author

@stewSquared stewSquared Mar 20, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was a little bit tricky to work out.
Akka HTP already includes a FormData class that seems relevant here. Might that make handling all these nested maps a bit simpler?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, we used to use unfiltered and switch to akka http that's why we are not using it.

Personally, I'm not particularly taken with akka http so I would not want to increase our dependency on it.

case Product.ProductId(id) => Map("product" -> id)
}
}

logger.debug(s"Generated POST form parameters is $postFormParameters")

Expand Down