stripe / stripe-go / 5367
66%

DEFAULT BRANCH: master
Ran
Jobs 7
Files 138
Run time 2min
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
coverage: 86.137% (+0.03%) from 86.109%
5367

push

travis-ci

web-flow 
stripe-go v71 (#1055)

* Make API response accessible on returned API structs (#1054)

* Make API response accessible on returned API structs

Makes an API response struct containing niceties like the raw response
body, status, and request ID accessible via API resource structs
returned from client functions. For example:

    customer, err := customer.New(params)
    fmt.Printf("request ID = %s\n", customer.LastResponse.RequestID)

This is a feature that already exists in other language API libraries
and which is requested occasionally here, usually for various situations
involving more complex usage or desire for better observability.

-- Implementation

We introduce a few new types to make this work:

* `APIResponse`: Represents a response from the Stripe API and includes
  things like request ID, status, and headers. I elected to create my
  own object instead of reusing `http.Response` because it gives us a
  little more flexibility, and hides many of myriad of fields exposed by
  the `http` version, which will hopefully give us a little more API
  stability/forward compatibility.

* `APIResource`: A struct that contains `LastResponse` and is meant to
  represent any type that can we returned from a Stripe API endpoint. A
  coupon is an `APIResource` and so is a list object. This struct is
  embedded in response structs where appropriate across the whole API
  surface area (e.g. `Coupon`, `ListMeta`, etc.).

* `LastResponseGetter`: A very basic interface to an object that looks
  like an `APIResource`. This isn't strictly necessary, but gives us
  slightly more flexibility around the API and makes backward
  compatibility a little bit better for non-standard use cases (see the
  section on that below).

`stripe.Do` and other backend calls all start taking objects which are
`LastResponseGetter` instead of `interface{}`. This provides us with some
type safety around forgetting to include an embedded `APIResou... (continued)

5157 of 5987 relevant lines covered (86.14%)

92.47 hits per line

Jobs
ID Job ID Ran Files Coverage
1 5367.1 (STRIPE_MOCK_VERSION=0.87.0) 138
86.1
 Travis Job 5367.1
2 5367.2 (STRIPE_MOCK_VERSION=0.87.0) 138
86.1
 Travis Job 5367.2
3 5367.3 (STRIPE_MOCK_VERSION=0.87.0) 138
86.1
 Travis Job 5367.3
4 5367.4 (STRIPE_MOCK_VERSION=0.87.0) 138
86.12
 Travis Job 5367.4
5 5367.5 (STRIPE_MOCK_VERSION=0.87.0) 0
0.0
 Travis Job 5367.5
6 5367.6 (STRIPE_MOCK_VERSION=0.87.0) 0
0.0
 Travis Job 5367.6
7 5367.7 (STRIPE_MOCK_VERSION=0.87.0) 0
0.0
 Travis Job 5367.7
Source Files on build 5367