printfection 1.0.0

data/spec/line_item_spec.rb

@@ -0,0 +1,44 @@
+require 'printfection'
+
+module Printfection
+  describe LineItem do
+    it_behaves_like "Resource"
+    include_examples "Actions::Retrieve"
+    include_examples "Actions::Create"
+    include_examples "Actions::Update"
+    include_examples "Actions::Delete"
+  end
+
+  describe LineItem, ".uri" do
+    it "returns the base resource uri" do
+      expect(LineItem.uri).to eql "/lineitems"
+    end
+  end
+
+  describe LineItem, "properties" do
+    let(:json) do
+      JSON.parse <<-JSON
+        {
+          "id": 123,
+          "object": "lineitem",
+          "order_id": 1,
+          "item_id": 1,
+          "size_id": 2,
+          "quantity": 3,
+          "created_at": "2014-09-12T10:22:37Z"
+        }
+      JSON
+    end
+
+    it "gives access to JSON properties" do
+      line_item = LineItem.new(json)
+      expect(line_item.id).to eql 123
+      expect(line_item.order_id).to eql 1
+      expect(line_item.item_id).to eql 1
+      expect(line_item.size_id).to eql 2
+      expect(line_item.quantity).to eql 3
+      expect(line_item.created_at).to eql DateTime.parse("2014-09-12T10:22:37Z")
+    end
+  end
+end
+

data/spec/manifest_spec.rb

@@ -0,0 +1,81 @@
+require 'printfection'
+
+module Printfection
+  describe Manifest, "properties" do
+    let(:json) do
+      JSON.parse <<-JSON
+        {
+          "subtotal": 0,
+          "tax": 0,
+          "shipping": 0,
+          "fulfillment": 0,
+          "total": 0,
+          "created_at": "2014-09-12T10:22:37Z",
+          "received_at": null,
+          "approved_at": null,
+          "processed_at": null,
+          "shipped_at": null,
+          "completed_at": null,
+          "lineitems": [
+            {
+              "id": 1,
+              "object": "lineitem",
+              "order_id": 1,
+              "item_id": 2,
+              "size_id": 3,
+              "quantity": 4,
+              "created_at": "2014-09-12T10:22:37Z"
+            },
+            {
+              "id": 2,
+              "object": "lineitem",
+              "order_id": 1,
+              "item_id": 2,
+              "size_id": 3,
+              "quantity": 4,
+              "created_at": "2014-09-12T10:22:37Z"
+            }
+          ],
+          "shipments": [
+            {
+              "carrier": "UPS",
+              "method": "Ground",
+              "tracking_number": "12345678",
+              "created_at": "2014-09-12T10:22:37Z"
+            },
+            {
+              "carrier": "FedEx",
+              "method": "2DA",
+              "tracking_number": "90123456",
+              "created_at": "2014-09-12T10:22:37Z"
+            }
+          ]
+        }
+      JSON
+    end
+
+    it "gives access to JSON properties" do
+      manifest = Manifest.new(json)
+      expect(manifest.subtotal).to eql 0.0
+      expect(manifest.tax).to eql 0.0
+      expect(manifest.shipping).to eql 0.0
+      expect(manifest.fulfillment).to eql 0.0
+      expect(manifest.total).to eql 0.0
+      expect(manifest.created_at).to eql DateTime.parse("2014-09-12T10:22:37Z")
+      expect(manifest.received_at).to eql nil
+      expect(manifest.approved_at).to eql nil
+      expect(manifest.processed_at).to eql nil
+      expect(manifest.shipped_at).to eql nil
+      expect(manifest.completed_at).to eql nil
+
+      expect(manifest.line_items).to be_an Array
+      expect(manifest.line_items.count).to eql 2
+      expect(manifest.line_items.first).to be_a LineItem
+
+      expect(manifest.shipments).to be_an Array
+      expect(manifest.shipments.count).to eql 2
+      expect(manifest.shipments.first).to be_a Hashie::Mash
+    end
+  end
+end
+

data/spec/order_spec.rb

@@ -0,0 +1,277 @@
+require 'printfection'
+
+module Printfection
+  describe Order do
+    it_behaves_like "Resource"
+    include_examples "Actions::Retrieve"
+    include_examples "Actions::List"
+    include_examples "Actions::Create"
+    include_examples "Actions::Update"
+    include_examples "Actions::Delete"
+  end
+
+  describe Order, ".uri" do
+    it "returns the base resource uri" do
+      expect(Order.uri).to eql "/orders"
+    end
+  end
+
+  describe Order, "properties" do
+    let(:json) do
+      JSON.parse <<-JSON
+        {
+          "id": 1,
+          "object": "order",
+          "campaign_id": 2,
+          "status": "open",
+          "code": "nhou890o",
+          "url": "https://printfection.com/nhou890o",
+          "gift": false,
+          "gift_message": "",
+          "created_at": "2014-09-12T10:22:37Z",
+          "ship_to": {
+             "name": "Joseph Schmo",
+             "address": "123 Main Street",
+             "address2": "Suite 101",
+             "company": "ACME Inc.",
+             "city": "Denver",
+             "state": "Colorado",
+             "zip": "80202",
+             "country": "United States",
+             "email": "joseph.schmo@example.com",
+             "phone": "751-166-2910"
+          },
+          "lineitems": [
+            {
+              "id": 1,
+              "object": "lineitem",
+              "order_id": 1,
+              "item_id": 2,
+              "size_id": 3,
+              "quantity": 4,
+              "created_at": "2014-09-12T10:22:37Z"
+            },
+            {
+              "id": 2,
+              "object": "lineitem",
+              "order_id": 1,
+              "item_id": 2,
+              "size_id": 3,
+              "quantity": 4,
+              "created_at": "2014-09-12T10:22:37Z"
+            }
+          ],
+          "manifest": {
+            "subtotal": 0,
+            "tax": 0,
+            "shipping": 0,
+            "fulfillment": 0,
+            "total": 0,
+            "created_at": "2014-09-12T10:22:37Z",
+            "received_at": null,
+            "approved_at": null,
+            "processed_at": null,
+            "shipped_at": null,
+            "completed_at": null,
+            "lineitems": [
+              {
+                "id": 1,
+                "object": "lineitem",
+                "order_id": 1,
+                "item_id": 2,
+                "size_id": 3,
+                "quantity": 4,
+                "created_at": "2014-09-12T10:22:37Z"
+              },
+              {
+                "id": 2,
+                "object": "lineitem",
+                "order_id": 1,
+                "item_id": 2,
+                "size_id": 3,
+                "quantity": 4,
+                "created_at": "2014-09-12T10:22:37Z"
+              }
+            ],
+            "shipments": [
+              {
+                "carrier": "UPS",
+                "method": "Ground",
+                "tracking_number": "12345678",
+                "created_at": "2014-09-12T10:22:37Z"
+              },
+              {
+                "carrier": "FedEx",
+                "method": "2DA",
+                "tracking_number": "90123456",
+                "created_at": "2014-09-12T10:22:37Z"
+              }
+            ]
+          }
+        }
+      JSON
+    end
+
+    it "gives access to JSON properties" do
+      order = Order.new(json)
+      expect(order.id).to eql 1
+      expect(order.campaign_id).to eql 2
+      expect(order.created_at).to eql DateTime.parse("2014-09-12T10:22:37Z")
+      expect(order.code).to eql "nhou890o"
+      expect(order.url).to eql "https://printfection.com/nhou890o"
+      expect(order.gift).to eql false
+      expect(order.gift_message).to eql ""
+
+      expect(order.ship_to).to be_an Address
+      expect(order.manifest).to be_a Manifest
+
+      expect(order.line_items).to be_a Relation
+      expect(order.line_items.uri).to eql "/orders/1/lineitems"
+      expect(order.line_items.count).to eql 2
+      expect(order.line_items.first).to be_a LineItem
+    end
+  end
+
+  describe Order, "#place" do
+    it "performs a post to place the order" do
+      order = Order.new(:id => 123)
+      expect(Printfection).to receive(:post).
+                              with("/orders/123/place")
+      order.place
+    end
+  end
+
+  describe Order, "#cancel" do
+    it "deletes the order" do
+      order = Order.new(:id => 123)
+      expect(order).to receive(:delete)
+      order.cancel
+    end
+  end
+
+  describe Order, "#campaign" do
+    it "returns the order's Campaign" do
+      campaign = double
+      allow(Campaign).to receive(:retrieve).
+                         with(123).
+                         and_return(campaign)
+      order = Order.new(campaign_id: 123)
+      expect(order.campaign).to eql campaign
+    end
+  end
+
+  describe Order, "#open?" do
+    it "returns true when the order's status is 'open'" do
+      order = Order.new status: "open"
+      expect(order.open?).to eql true
+    end
+
+    it "returns false when the order's status is not 'open'" do
+      order = Order.new status: "cancelled"
+      expect(order.open?).to eql false
+    end
+  end
+
+  describe Order, "#cancelled?" do
+    it "returns true when the order's status is 'cancelled'" do
+      order = Order.new status: "cancelled"
+      expect(order.cancelled?).to eql true
+    end
+
+    it "returns false when the order's status is not 'cancelled'" do
+      order = Order.new status: "open"
+      expect(order.cancelled?).to eql false
+    end
+  end
+
+  describe Order, "#received?" do
+    it "returns true when the order's status is 'received'" do
+      order = Order.new status: "received"
+      expect(order.received?).to eql true
+    end
+
+    it "returns true when the order's status is 'approved'" do
+      order = Order.new status: "approved"
+      expect(order.received?).to eql true
+    end
+
+    it "returns true when the order's status is 'processed'" do
+      order = Order.new status: "processed"
+      expect(order.received?).to eql true
+    end
+
+    it "returns true when the order's status is 'shipped'" do
+      order = Order.new status: "shipped"
+      expect(order.received?).to eql true
+    end
+
+    it "returns true when the order's status is 'completed'" do
+      order = Order.new status: "completed"
+      expect(order.received?).to eql true
+    end
+  end
+
+  describe Order, "#approved?" do
+    it "returns true when the order's status is 'approved'" do
+      order = Order.new status: "approved"
+      expect(order.approved?).to eql true
+    end
+
+    it "returns true when the order's status is 'processed'" do
+      order = Order.new status: "processed"
+      expect(order.approved?).to eql true
+    end
+
+    it "returns true when the order's status is 'shipped'" do
+      order = Order.new status: "shipped"
+      expect(order.approved?).to eql true
+    end
+
+    it "returns true when the order's status is 'completed'" do
+      order = Order.new status: "completed"
+      expect(order.approved?).to eql true
+    end
+  end
+
+  describe Order, "#processed?" do
+    it "returns true when the order's status is 'processed'" do
+      order = Order.new status: "processed"
+      expect(order.processed?).to eql true
+    end
+
+    it "returns true when the order's status is 'shipped'" do
+      order = Order.new status: "shipped"
+      expect(order.processed?).to eql true
+    end
+
+    it "returns true when the order's status is 'completed'" do
+      order = Order.new status: "completed"
+      expect(order.processed?).to eql true
+    end
+  end
+
+  describe Order, "#shipped?" do
+    it "returns true when the order's status is 'shipped'" do
+      order = Order.new status: "shipped"
+      expect(order.shipped?).to eql true
+    end
+
+    it "returns true when the order's status is 'completed'" do
+      order = Order.new status: "completed"
+      expect(order.shipped?).to eql true
+    end
+  end
+
+  describe Order, "#completed?" do
+    it "returns true when the order's status is 'completed'" do
+      order = Order.new status: "completed"
+      expect(order.completed?).to eql true
+    end
+
+    it "returns false when the order's status is not 'completed'" do
+      order = Order.new status: "open"
+      expect(order.completed?).to eql false
+    end
+  end
+end
+

data/spec/printfection_spec.rb

@@ -0,0 +1,2 @@
+require 'printfection'
+

data/spec/product_spec.rb

@@ -0,0 +1,21 @@
+require 'printfection'
+
+module Printfection
+  describe Product, "properties" do
+    let(:json) do
+      JSON.parse <<-JSON
+        {
+          "id": 123,
+          "name": "American Apparel 50/50 T-Shirt"
+        }
+      JSON
+    end
+
+    it "gives access to JSON properties" do
+      product = Product.new(json)
+      expect(product.id).to eql 123
+      expect(product.name).to eql "American Apparel 50/50 T-Shirt"
+    end
+  end
+end
+

data/spec/relation_spec.rb

@@ -0,0 +1,154 @@
+require 'printfection'
+
+module Printfection
+  describe Relation do
+    it "behaves like a collection" do
+      author   = {id: 1}
+      books    = [{title: "Book 1"}, {title: "Book 2"}]
+
+      relation = Relation.new(
+        parent:   author,
+        children: books,
+        path:     '/books',
+        keys:     {:id => :author_id}
+      )
+
+      expect(relation.size).to eql (2)
+      expect(relation.length).to eql (2)
+      expect(relation.count).to eql (2)
+
+      titles = relation.map { |book| book[:title] }
+      expect(titles).to eql ["Book 1", "Book 2"]
+    end
+
+    it "applies the parent keys to the children" do
+      author   = {id: 1, name: "Mark Twain"}
+      books    = [{title: "Book 1"}, {title: "Book 2"}]
+
+      relation = Relation.new(
+        parent:   author,
+        children: books,
+        path:     '/books',
+        keys:     {:id => :author_id, :name => :author_name}
+      )
+
+      expect(relation.first).to eql({title: "Book 1", author_id: 1, author_name: "Mark Twain"})
+      expect(relation.last).to eql({title: "Book 2", author_id: 1, author_name: "Mark Twain"})
+    end
+
+    it "applies the relation to the childrenance" do
+      book_klass = Class.new(Resource) do
+        property :title
+        property :author_id
+        property :author_name
+      end
+
+      author   = {id: 1, name: "Mark Twain"}
+      books    = [book_klass.new({title: "Book 1"}), book_klass.new({title: "Book 2"})]
+
+      relation = Relation.new(
+        children: books
+      )
+
+      expect(relation.first.relation).to eql relation
+      expect(relation.last.relation).to eql relation
+    end
+
+
+    it "includes the provided actions" do
+      parent   = double.as_null_object
+      children = double.as_null_object
+
+      action1 = Module.new do
+        def action1_action
+        end
+      end
+
+      action2 = Module.new do
+        def action2_action
+        end
+      end
+
+      relation = Relation.new(
+        parent:   parent,
+        children: children,
+        actions:  [action1, action2]
+      )
+
+      expect(relation).to respond_to :action1_action
+      expect(relation).to respond_to :action2_action
+    end
+  end
+
+  describe Relation, "#uri" do
+    it "returns a URI for collection actions" do
+      author = double(:author, uri: "/authors/1").as_null_object
+      books = [{title: "Book 1"}, {title: "Book 2"}]
+
+      relation = Relation.new(
+        parent:   author,
+        children: books,
+        path:     '/books',
+        keys:     {:id => :author_id}
+      )
+
+      expect(relation.uri).to eql "/authors/1/books"
+    end
+  end
+
+  describe Relation, "#new" do
+    it "invokes the constructor of the child class and returns the result" do
+      author = double(:author, uri: "/authors/1").as_null_object
+      books = [{title: "Book 1"}, {title: "Book 2"}]
+
+      klass = Class.new
+      instance = double.as_null_object
+
+      relation = Relation.new(
+        parent:   author,
+        children: books,
+        klass:    klass,
+        path:     '/books',
+        keys:     {:id => :author_id}
+      )
+
+      expect(klass).to receive(:new).
+                       with({id: 123, age: 12, quantity: 100}).
+                       and_return(instance)
+
+      expect(relation.new({id: 123, age: 12, quantity: 100})).to eql instance
+    end
+
+    it "applies the parent keys to the new instance" do
+      author = {id: 1, name: "Mark Twain"}
+
+      relation = Relation.new(
+        parent:   author,
+        klass:    Hashie::Mash,
+        keys:     {:id  => :author_id, :name => :author_name}
+      )
+
+      instance = relation.new({
+        id: 2,
+        author_id: 2
+      })
+
+      expect(instance[:id]).to eql 2
+      expect(instance[:author_id]).to eql 1
+      expect(instance[:author_name]).to eql "Mark Twain"
+    end
+
+    it "applies the relation to the new instance" do
+      author = double(:author, :uri => "/authors/123").as_null_object
+
+      relation = Relation.new(
+        parent: author,
+        klass: Resource
+      )
+
+      instance = relation.new
+      expect(instance.relation).to eql relation
+    end
+  end
+end
+

data/spec/resource_spec.rb

@@ -0,0 +1,62 @@
+require 'printfection'
+
+module Printfection
+  describe Resource, "relation" do
+    it "saves its relation" do
+      relation = double
+      resource = Resource.new
+      resource.relation = relation
+      expect(resource.relation).to eql relation
+    end
+  end
+end
+
+module Printfection
+  describe Resource, "#uri" do
+    let(:widget_klass) do
+      Class.new(Resource) do
+        property :id
+
+        def self.uri
+          "/widgets"
+        end
+      end
+    end
+
+    context "when it does not have a relation" do
+      it "returns its class's uri joined with its id" do
+        widget = widget_klass.new(id: 123)
+        expect(widget.uri).to eql "/widgets/123"
+      end
+    end
+
+    context "when it has a relation" do
+      it "returns its relations's uri joined with its id" do
+        relation = double(:uri => "/manufacturers/123/widgets")
+        widget = widget_klass.new(id: 456)
+        widget.relation = relation
+        expect(widget.uri).to eql "/manufacturers/123/widgets/456"
+      end
+    end
+  end
+end
+
+module Printfection
+  describe Resource, "#changes" do
+    it "returns a hash of the changed properties" do
+      klass = Class.new(Resource) do
+        property :size
+        property :color
+        property :price
+      end
+      resource = klass.new(size: "Large", color: "Blue", price: 123.45)
+      resource.price = 678.90
+      expect(resource.changes).to eql({"price" => 678.90})
+      resource.size = "Medium"
+      expect(resource.changes).to eql({"size" => "Medium", "price" => 678.90})
+      resource.price = 123.45
+      expect(resource.changes).to eql({"size" => "Medium"})
+    end
+  end
+end
+

data/spec/size_spec.rb

@@ -0,0 +1,30 @@
+require 'printfection'
+
+module Printfection
+  describe Size, "properties" do
+    let(:json) do
+      JSON.parse <<-JSON
+        {
+          "id": 1,
+          "object": "size",
+          "name": "Medium",
+          "short_name": "M",
+          "stock": {
+            "available": 498
+          }
+        }
+      JSON
+    end
+
+    it "gives access to JSON properties" do
+      size = Size.new(json)
+      expect(size.id).to eql 1
+      expect(size.name).to eql "Medium"
+      expect(size.short_name).to eql "M"
+
+      expect(size.stock).to be_a Hashie::Mash
+      expect(size.stock.available).to eql 498
+    end
+  end
+end
+