Add Location endpoint. (#25)

fixtures/location.json

@@ -0,0 +1,21 @@
+{
+  "location": {
+    "id": 4688969785,
+    "name": "Bajkowa",
+    "address1": "Bajkowa",
+    "address2": "",
+    "city": "Olsztyn",
+    "zip": "10-001",
+    "province": null,
+    "country": "PL",
+    "phone": "12312312",
+    "created_at": "2018-02-19T16:18:59-05:00",
+    "updated_at": "2018-02-19T16:19:00-05:00",
+    "country_code": "PL",
+    "country_name": "Poland",
+    "province_code": null,
+    "legacy": false,
+    "active": true,
+    "admin_graphql_api_id": "gid:\/\/shopify\/Location\/4688969785"
+  }
+}

fixtures/locations.json

@@ -0,0 +1,23 @@
+{
+  "locations": [
+    {
+      "id": 4688969785,
+      "name": "Bajkowa",
+      "address1": "Bajkowa",
+      "address2": "",
+      "city": "Olsztyn",
+      "zip": "10-001",
+      "province": null,
+      "country": "PL",
+      "phone": "12312312",
+      "created_at": "2018-02-19T16:18:59-05:00",
+      "updated_at": "2018-02-19T16:19:00-05:00",
+      "country_code": "PL",
+      "country_name": "Poland",
+      "province_code": null,
+      "legacy": false,
+      "active": true,
+      "admin_graphql_api_id": "gid:\/\/shopify\/Location\/4688969785"
+    }
+  ]
+}

goshopify.go

@@ -71,6 +71,7 @@ type Client struct {
 	Page                       PageService
 	StorefrontAccessToken      StorefrontAccessTokenService
 	Collect                    CollectService
+	Location                   LocationService
 }
 
 // A general response error that follows a similar layout to Shopify's response
@@ -209,6 +210,7 @@ func NewClient(app App, shopName, token string) *Client {
 	c.StorefrontAccessToken = &StorefrontAccessTokenServiceOp{client: c}
 	c.UsageCharge = &UsageChargeServiceOp{client: c}
 	c.Collect = &CollectServiceOp{client: c}
+	c.Location = &LocationServiceOp{client: c}
 
 	return c
 }

location.go

@@ -0,0 +1,110 @@
+package goshopify
+
+import (
+	"fmt"
+	"time"
+)
+
+const locationsBasePath = "admin/locations"
+
+// LocationService is an interface for interfacing with the location endpoints
+// of the Shopify API.
+// See: https://help.shopify.com/en/api/reference/inventory/location
+type LocationService interface {
+	// Retrieves a list of locations
+	List(options interface{}) ([]Location, error)
+	// Retrieves a single location by its ID
+	Get(ID int, options interface{}) (*Location, error)
+	// Retrieves a count of locations
+	Count(options interface{}) (int, error)
+}
+
+type Location struct {
+	// Whether the location is active.If true, then the location can be used to sell products,
+	// stock inventory, and fulfill orders.Merchants can deactivate locations from the Shopify admin.
+	// Deactivated locations don't contribute to the shop's location limit.
+	Active bool `json:"active"`
+
+	// The first line of the address.
+	Address1 string `json:"address1"`
+
+	// The second line of the address.
+	Address2 string `json:"address2"`
+
+	// The city the location is in.
+	City string `json:"city"`
+
+	// The country the location is in.
+	Country string `json:"country"`
+
+	// The two-letter code (ISO 3166-1 alpha-2 format) corresponding to country the location is in.
+	CountryCode string `json:"country_code"`
+
+	CountryName string `json:"country_name"`
+
+	// The date and time (ISO 8601 format) when the location was created.
+	CreatedAt time.Time `json:"created_at"`
+
+	// The ID for the location.
+	ID int `json:"id"`
+
+	// Whether this is a fulfillment service location.
+	// If true, then the location is a fulfillment service location.
+	// If false, then the location was created by the merchant and isn't tied to a fulfillment service.
+	Legacy bool `json:"legacy"`
+
+	// The name of the location.
+	Name string `json:"name"`
+
+	// The phone number of the location.This value can contain special characters like - and +.
+	Phone string `json:"phone"`
+
+	// The province the location is in.
+	Province string `json:"province"`
+
+	// The two-letter code corresponding to province or state the location is in.
+	ProvinceCode string `json:"province_code"`
+
+	// The date and time (ISO 8601 format) when the location was last updated.
+	UpdatedAt time.Time `json:"updated_at"`
+
+	// The zip or postal code.
+	Zip string `json:"zip"`
+
+	AdminGraphqlAPIID string `json:"admin_graphql_api_id"`
+}
+
+// LocationServiceOp handles communication with the location related methods of
+// the Shopify API.
+type LocationServiceOp struct {
+	client *Client
+}
+
+func (s *LocationServiceOp) List(options interface{}) ([]Location, error) {
+	path := fmt.Sprintf("%s.json", locationsBasePath)
+	resource := new(LocationsResource)
+	err := s.client.Get(path, resource, options)
+	return resource.Locations, err
+}
+
+func (s *LocationServiceOp) Get(ID int, options interface{}) (*Location, error) {
+	path := fmt.Sprintf("%s/%d.json", locationsBasePath, ID)
+	resource := new(LocationResource)
+	err := s.client.Get(path, resource, options)
+	return resource.Location, err
+}
+
+func (s *LocationServiceOp) Count(options interface{}) (int, error) {
+	path := fmt.Sprintf("%s/count.json", locationsBasePath)
+	return s.client.Count(path, options)
+}
+
+// Represents the result from the locations/X.json endpoint
+type LocationResource struct {
+	Location *Location `json:"location"`
+}
+
+// Represents the result from the locations.json endpoint
+type LocationsResource struct {
+	Locations []Location `json:"locations"`
+}

location_test.go

@@ -0,0 +1,103 @@
+package goshopify
+
+import (
+	"reflect"
+	"testing"
+	"time"
+
+	"gopkg.in/jarcoal/httpmock.v1"
+)
+
+func TestLocationServiceOp_List(t *testing.T) {
+	setup()
+	defer teardown()
+
+	httpmock.RegisterResponder("GET", "https://fooshop.myshopify.com/admin/locations.json",
+		httpmock.NewBytesResponder(200, loadFixture("locations.json")))
+
+	products, err := client.Location.List(nil)
+	if err != nil {
+		t.Errorf("Location.List returned error: %v", err)
+	}
+
+	created, _ := time.Parse(time.RFC3339, "2018-02-19T16:18:59-05:00")
+	updated, _ := time.Parse(time.RFC3339, "2018-02-19T16:19:00-05:00")
+
+	expected := []Location{{
+		ID:                4688969785,
+		Name:              "Bajkowa",
+		Address1:          "Bajkowa",
+		Address2:          "",
+		City:              "Olsztyn",
+		Zip:               "10-001",
+		Country:           "PL",
+		Phone:             "12312312",
+		CreatedAt:         created,
+		UpdatedAt:         updated,
+		CountryCode:       "PL",
+		CountryName:       "Poland",
+		Legacy:            false,
+		Active:            true,
+		AdminGraphqlAPIID: "gid://shopify/Location/4688969785",
+	}}
+
+	if !reflect.DeepEqual(products, expected) {
+		t.Errorf("Location.List returned %+v, expected %+v", products, expected)
+	}
+}
+
+func TestLocationServiceOp_Get(t *testing.T) {
+	setup()
+	defer teardown()
+
+	httpmock.RegisterResponder("GET", "https://fooshop.myshopify.com/admin/locations/4688969785.json",
+		httpmock.NewBytesResponder(200, loadFixture("location.json")))
+
+	product, err := client.Location.Get(4688969785, nil)
+	if err != nil {
+		t.Errorf("Location.Get returned error: %v", err)
+	}
+
+	created, _ := time.Parse(time.RFC3339, "2018-02-19T16:18:59-05:00")
+	updated, _ := time.Parse(time.RFC3339, "2018-02-19T16:19:00-05:00")
+
+	expected := &Location{
+		ID:                4688969785,
+		Name:              "Bajkowa",
+		Address1:          "Bajkowa",
+		Address2:          "",
+		City:              "Olsztyn",
+		Zip:               "10-001",
+		Country:           "PL",
+		Phone:             "12312312",
+		CreatedAt:         created,
+		UpdatedAt:         updated,
+		CountryCode:       "PL",
+		CountryName:       "Poland",
+		Legacy:            false,
+		Active:            true,
+		AdminGraphqlAPIID: "gid://shopify/Location/4688969785",
+	}
+
+	if !reflect.DeepEqual(product, expected) {
+		t.Errorf("Location.Get returned %+v, expected %+v", product, expected)
+	}
+}
+
+func TestLocationServiceOp_Count(t *testing.T) {
+	setup()
+	defer teardown()
+
+	httpmock.RegisterResponder("GET", "https://fooshop.myshopify.com/admin/locations/count.json",
+		httpmock.NewStringResponder(200, `{"count": 3}`))
+
+	cnt, err := client.Location.Count(nil)
+	if err != nil {
+		t.Errorf("Location.Count returned error: %v", err)
+	}
+
+	expected := 3
+	if cnt != expected {
+		t.Errorf("Location.Count returned %d, expected %d", cnt, expected)
+	}
+}