Add support for Blog API (#95)

* Implement blog service (CRUD)

* Added test for blog service

* Register blog service on client

* Remove GetTags func so coverage can be 100%

Author: MarinX

blog.go

@@ -0,0 +1,96 @@
+package goshopify
+
+import (
+	"fmt"
+	"time"
+)
+
+const blogsBasePath = "admin/blogs"
+
+// BlogService is an interface for interfacing with the blogs endpoints
+// of the Shopify API.
+// See: https://help.shopify.com/api/reference/online_store/blog
+type BlogService interface {
+	List(interface{}) ([]Blog, error)
+	Count(interface{}) (int, error)
+	Get(int, interface{}) (*Blog, error)
+	Create(Blog) (*Blog, error)
+	Update(Blog) (*Blog, error)
+	Delete(int) error
+}
+
+// BlogServiceOp handles communication with the blog related methods of
+// the Shopify API.
+type BlogServiceOp struct {
+	client *Client
+}
+
+// Blog represents a Shopify blog
+type Blog struct {
+	ID                 int        `json:"id"`
+	Title              string     `json:"title"`
+	Commentable        string     `json:"commentable"`
+	Feedburner         string     `json:"feedburner"`
+	FeedburnerLocation string     `json:"feedburner_location"`
+	Handle             string     `json:"handle"`
+	Metafield          Metafield  `json:"metafield"`
+	Tags               string     `json:"tags"`
+	TemplateSuffix     string     `json:"template_suffix"`
+	CreatedAt          *time.Time `json:"created_at"`
+	UpdatedAt          *time.Time `json:"updated_at"`
+}
+
+// BlogsResource is the result from the blogs.json endpoint
+type BlogsResource struct {
+	Blogs []Blog `json:"blogs"`
+}
+
+// Represents the result from the blogs/X.json endpoint
+type BlogResource struct {
+	Blog *Blog `json:"blog"`
+}
+
+// List all blogs
+func (s *BlogServiceOp) List(options interface{}) ([]Blog, error) {
+	path := fmt.Sprintf("%s.json", blogsBasePath)
+	resource := new(BlogsResource)
+	err := s.client.Get(path, resource, options)
+	return resource.Blogs, err
+}
+
+// Count blogs
+func (s *BlogServiceOp) Count(options interface{}) (int, error) {
+	path := fmt.Sprintf("%s/count.json", blogsBasePath)
+	return s.client.Count(path, options)
+}
+
+// Get single blog
+func (s *BlogServiceOp) Get(blogId int, options interface{}) (*Blog, error) {
+	path := fmt.Sprintf("%s/%d.json", blogsBasePath, blogId)
+	resource := new(BlogResource)
+	err := s.client.Get(path, resource, options)
+	return resource.Blog, err
+}
+
+// Create a new blog
+func (s *BlogServiceOp) Create(blog Blog) (*Blog, error) {
+	path := fmt.Sprintf("%s.json", blogsBasePath)
+	wrappedData := BlogResource{Blog: &blog}
+	resource := new(BlogResource)
+	err := s.client.Post(path, wrappedData, resource)
+	return resource.Blog, err
+}
+
+// Update an existing blog
+func (s *BlogServiceOp) Update(blog Blog) (*Blog, error) {
+	path := fmt.Sprintf("%s/%d.json", blogsBasePath, blog.ID)
+	wrappedData := BlogResource{Blog: &blog}
+	resource := new(BlogResource)
+	err := s.client.Put(path, wrappedData, resource)
+	return resource.Blog, err
+}
+
+// Delete an blog
+func (s *BlogServiceOp) Delete(blogId int) error {
+	return s.client.Delete(fmt.Sprintf("%s/%d.json", blogsBasePath, blogId))
+}

blog_test.go

@@ -0,0 +1,154 @@
+package goshopify
+
+import (
+	"reflect"
+	"testing"
+
+	"gopkg.in/jarcoal/httpmock.v1"
+)
+
+func TestBlogList(t *testing.T) {
+	setup()
+	defer teardown()
+
+	httpmock.RegisterResponder(
+		"GET",
+		"https://fooshop.myshopify.com/admin/blogs.json",
+		httpmock.NewStringResponder(
+			200,
+			`{"blogs": [{"id":1},{"id":2}]}`,
+		),
+	)
+
+	blogs, err := client.Blog.List(nil)
+	if err != nil {
+		t.Errorf("Blog.List returned error: %v", err)
+	}
+
+	expected := []Blog{{ID: 1}, {ID: 2}}
+	if !reflect.DeepEqual(blogs, expected) {
+		t.Errorf("Blog.List returned %+v, expected %+v", blogs, expected)
+	}
+
+}
+
+func TestBlogCount(t *testing.T) {
+	setup()
+	defer teardown()
+
+	httpmock.RegisterResponder(
+		"GET",
+		"https://fooshop.myshopify.com/admin/blogs/count.json",
+		httpmock.NewStringResponder(
+			200,
+			`{"count": 5}`,
+		),
+	)
+
+	cnt, err := client.Blog.Count(nil)
+	if err != nil {
+		t.Errorf("Blog.Count returned error: %v", err)
+	}
+
+	expected := 5
+	if cnt != expected {
+		t.Errorf("Blog.Count returned %d, expected %d", cnt, expected)
+	}
+
+}
+
+func TestBlogGet(t *testing.T) {
+	setup()
+	defer teardown()
+
+	httpmock.RegisterResponder(
+		"GET",
+		"https://fooshop.myshopify.com/admin/blogs/1.json",
+		httpmock.NewStringResponder(
+			200,
+			`{"blog": {"id":1}}`,
+		),
+	)
+
+	blog, err := client.Blog.Get(1, nil)
+	if err != nil {
+		t.Errorf("Blog.Get returned error: %v", err)
+	}
+
+	expected := &Blog{ID: 1}
+	if !reflect.DeepEqual(blog, expected) {
+		t.Errorf("Blog.Get returned %+v, expected %+v", blog, expected)
+	}
+
+}
+
+func TestBlogCreate(t *testing.T) {
+	setup()
+	defer teardown()
+
+	httpmock.RegisterResponder(
+		"POST",
+		"https://fooshop.myshopify.com/admin/blogs.json",
+		httpmock.NewBytesResponder(
+			200,
+			loadFixture("blog.json"),
+		),
+	)
+
+	blog := Blog{
+		Title: "Mah Blog",
+	}
+
+	returnedBlog, err := client.Blog.Create(blog)
+	if err != nil {
+		t.Errorf("Blog.Create returned error: %v", err)
+	}
+
+	expectedInt := 241253187
+	if returnedBlog.ID != expectedInt {
+		t.Errorf("Blog.ID returned %+v, expected %+v", returnedBlog.ID, expectedInt)
+	}
+
+}
+
+func TestBlogUpdate(t *testing.T) {
+	setup()
+	defer teardown()
+
+	httpmock.RegisterResponder(
+		"PUT",
+		"https://fooshop.myshopify.com/admin/blogs/1.json",
+		httpmock.NewBytesResponder(
+			200,
+			loadFixture("blog.json"),
+		),
+	)
+
+	blog := Blog{
+		ID:    1,
+		Title: "Mah Blog",
+	}
+
+	returnedBlog, err := client.Blog.Update(blog)
+	if err != nil {
+		t.Errorf("Blog.Update returned error: %v", err)
+	}
+
+	expectedInt := 241253187
+	if returnedBlog.ID != expectedInt {
+		t.Errorf("Blog.ID returned %+v, expected %+v", returnedBlog.ID, expectedInt)
+	}
+}
+
+func TestBlogDelete(t *testing.T) {
+	setup()
+	defer teardown()
+
+	httpmock.RegisterResponder("DELETE", "https://fooshop.myshopify.com/admin/blogs/1.json",
+		httpmock.NewStringResponder(200, "{}"))
+
+	err := client.Blog.Delete(1)
+	if err != nil {
+		t.Errorf("Blog.Delete returned error: %v", err)
+	}
+}

fixtures/blog.json

@@ -0,0 +1,14 @@
+{
+  "blog": {
+    "id": 241253187,
+    "handle": "apple-blog",
+    "title": "Mah Blog",
+    "updated_at": "2006-02-01T19:00:00-05:00",
+    "commentable": "no",
+    "feedburner": null,
+    "feedburner_location": null,
+    "created_at": "2018-05-07T15:33:38-04:00",
+    "template_suffix": null,
+    "tags": "Announcing, Mystery"
+  }
+}

goshopify.go

@@ -63,6 +63,7 @@ type Client struct {
 	ScriptTag                  ScriptTagService
 	RecurringApplicationCharge RecurringApplicationChargeService
 	Metafield                  MetafieldService
+	Blog                       BlogService
 }
 
 // A general response error that follows a similar layout to Shopify's response
@@ -184,6 +185,7 @@ func NewClient(app App, shopName, token string) *Client {
 	c.ScriptTag = &ScriptTagServiceOp{client: c}
 	c.RecurringApplicationCharge = &RecurringApplicationChargeServiceOp{client: c}
 	c.Metafield = &MetafieldServiceOp{client: c}
+	c.Blog = &BlogServiceOp{client: c}
 
 	return c
 }