printfection 1.0.0

data/lib/printfection/relation.rb

@@ -0,0 +1,59 @@
+module Printfection
+  class Relation
+    include Enumerable
+    extend Forwardable
+    def_delegators :@children, :each, :first, :last, :size, :count, :length
+
+    attr_reader :parent, :children, :klass, :path, :keys, :actions
+
+    def initialize(options={})
+      options = {
+        parent:   nil,
+        children: [],
+        klass:    Hashie::Mash,
+        path:     "",
+        keys:     {},
+        actions:  []
+      }.merge(options)
+
+      @parent   = options.fetch(:parent)
+      @children = options.fetch(:children)
+      @klass    = options.fetch(:klass)
+      @path     = options.fetch(:path)
+      @keys     = options.fetch(:keys)
+      @actions  = options.fetch(:actions)
+
+      actions.each do |mod|
+        self.extend(mod)
+      end
+
+      children.each do |child|
+        apply_relation(child)
+      end
+    end
+
+    def uri
+      Util.join_uri(parent.uri, path)
+    end
+
+    def new(*args)
+      child = klass.new(*args)
+      apply_relation(child)
+      return child
+    end
+
+    private
+
+    def apply_relation(child)
+      keys.each do |primary, foreign|
+        child[foreign] = parent[primary]
+      end
+
+      if child.respond_to? :relation=
+        child.relation = self
+      end
+    end
+
+  end
+end
+

data/lib/printfection/resource.rb

@@ -0,0 +1,31 @@
+module Printfection
+  class Resource < Hashie::Trash
+    include Hashie::Extensions::IndifferentAccess
+    include Hashie::Extensions::Coercion
+
+    property :object
+
+    attr_accessor :relation
+
+    def initialize(*args)
+      super
+      @_old = self.dup
+    end
+
+    def uri
+      base = self.relation.nil? ? self.class.uri : self.relation.uri
+      Util.join_uri(base, self.id)
+    end
+
+    def changes
+      keys.inject({}) do |diff, key|
+        unless self[key] == @_old[key]
+          diff[key] = self[key]
+        end
+        diff
+      end
+    end
+
+  end
+end
+

data/lib/printfection/size.rb

@@ -0,0 +1,11 @@
+module Printfection
+  class Size < Resource
+    property :id, transform_with: Transforms::Integer
+    property :name
+    property :short_name
+
+    property :stock
+    coerce_key :stock, Hashie::Mash
+  end
+end
+

data/lib/printfection/transforms.rb

@@ -0,0 +1,8 @@
+module Printfection
+  module Transforms
+    Integer = lambda { |v| v.to_i }
+    Float   = lambda { |v| v.to_f }
+    Date    = lambda { |v| v.nil? ? nil : DateTime.parse(v) }
+  end
+end
+

data/lib/printfection/util.rb

@@ -0,0 +1,8 @@
+module Printfection
+  module Util
+    def self.join_uri(*args)
+      Array(args).join("/").gsub(/\/{2,}/, "/").chomp("/")
+    end
+  end
+end
+

data/lib/printfection/version.rb

@@ -0,0 +1,4 @@
+module Printfection
+  VERSION = "1.0.0"
+end
+

data/lib/printfection.rb

@@ -0,0 +1,27 @@
+require "json"
+require "hashie"
+require "restclient"
+require "forwardable"
+
+require "printfection/version"
+require "printfection/util"
+require "printfection/error"
+require "printfection/api"
+require "printfection/transforms"
+require "printfection/relation"
+require "printfection/resource"
+require "printfection/actions"
+require "printfection/address"
+require "printfection/product"
+require "printfection/size"
+require "printfection/asset"
+require "printfection/campaign"
+require "printfection/item"
+require "printfection/line_item"
+require "printfection/manifest"
+require "printfection/order"
+
+module Printfection
+  extend API
+end
+

data/printfection.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'printfection/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "printfection"
+  spec.version       = Printfection::VERSION
+  spec.authors       = ["Casey O'Hara"]
+  spec.email         = ["casey.ohara@printfection.com"]
+  spec.summary       = "Implementation of the Printfection API for Ruby"
+  spec.description   = ""
+  spec.homepage      = "https://github.com/printfection/printfection-ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "hashie", "~> 3.3.1"
+  spec.add_dependency "rest-client", "~> 1.7.2"
+
+  spec.add_development_dependency "bundler", ">= 1.6.8"
+  spec.add_development_dependency "rake", "10.3.2"
+  spec.add_development_dependency "rspec", "3.1.0"
+  spec.add_development_dependency "codeclimate-test-reporter"
+end
+

data/spec/actions_spec.rb

@@ -0,0 +1,83 @@
+require 'printfection'
+
+module Printfection
+  class Widget < Resource
+    extend Actions::Retrieve
+    extend Actions::List
+    extend Actions::Create
+    include Actions::Update
+    include Actions::Delete
+
+    property :id
+    property :size
+    property :quantity
+
+    def self.uri
+      "/widgets"
+    end
+  end
+
+  describe Actions::Retrieve, ".retrieve" do
+    it "returns an instance of the resource for the given id" do
+      json_data = double
+      widget = double
+
+      expect(Printfection).to receive(:get).with("/widgets/123").and_return(json_data)
+      expect(Widget).to receive(:new).with(json_data).and_return(widget)
+      expect(Widget.retrieve(123)).to eql widget
+    end
+  end
+
+  describe Actions::List, ".all" do
+    it "returns an array of instances of the resource" do
+      json_data1, json_data2 = double, double
+      widget1, widget2 = double, double
+
+      expect(Printfection).to receive(:get).
+                              with("/widgets", {offset: 10, limit: 5}).
+                              and_return([json_data1, json_data2])
+      expect(Widget).to receive(:new).with(json_data1).and_return(widget1)
+      expect(Widget).to receive(:new).with(json_data2).and_return(widget2)
+
+      expect(Widget.all(offset: 10, limit: 5)).to eql [widget1, widget2]
+    end
+  end
+
+  describe Actions::Create, ".create" do
+    it "creates, saves, and returns a new resource with the response data" do
+      params = double
+      json_data = double
+      new_widget = double
+
+      expect(Printfection).to receive(:post).
+                              with("/widgets", params).
+                              and_return(json_data)
+
+      expect(Widget).to receive(:new).
+                        with(json_data).
+                        and_return(new_widget)
+
+      widget = Widget.create(params)
+      expect(widget).to eql new_widget
+    end
+  end
+
+  describe Actions::Update, "#save" do
+    it "performs a patch with the resource's changed data" do
+      widget = Widget.new(:id => 123, :size => "Medium", :quantity => 5)
+      widget.size = "Large"
+      expect(Printfection).to receive(:patch).
+                              with("/widgets/123", {"size" => "Large"})
+      widget.save
+    end
+  end
+
+  describe Actions::Delete, "#delete" do
+    it "performs a delete on the resource" do
+      widget = Widget.new(:id => 123)
+      expect(Printfection).to receive(:delete).with("/widgets/123")
+      widget.delete
+    end
+  end
+end
+

data/spec/api_spec.rb

@@ -0,0 +1,224 @@
+require 'printfection'
+
+module Printfection
+  describe API, ".api_token=" do
+    let(:client) { Object.new.extend(API) }
+
+    it "sets the api token" do
+      client.api_token = "MY-API-TOKEN"
+      expect(client.api_token).to eql "MY-API-TOKEN"
+    end
+  end
+
+  describe API, "#get" do
+    let(:client) { Object.new.extend(API) }
+
+    before do
+      client.api_token = "MY-API-TOKEN"
+    end
+
+    it "returns the response data of a GET request" do
+      response_data = double
+      expect(client).to receive(:request).
+                        with(:get, "/path/to/resource/123", {page: 5}).
+                        and_return(response_data)
+      expect(client.get("/path/to/resource/123", page: 5)).to eql response_data
+    end
+  end
+
+  describe API, "#post" do
+    let(:client) { Object.new.extend(API) }
+
+    before do
+      client.api_token = "MY-API-TOKEN"
+    end
+
+    it "returns the response data of a POST request" do
+      response_data = double
+      expect(client).to receive(:request).
+                        with(:post, "/path/to/resource/123", {page: 5}).
+                        and_return(response_data)
+      expect(client.post("/path/to/resource/123", page: 5)).to eql response_data
+    end
+  end
+
+  describe API, "#patch" do
+    let(:client) { Object.new.extend(API) }
+
+    before do
+      client.api_token = "MY-API-TOKEN"
+    end
+
+    it "returns the response data of a PATCH request" do
+      response_data = double
+      expect(client).to receive(:request).
+                        with(:patch, "/path/to/resource/123", {page: 5}).
+                        and_return(response_data)
+      expect(client.patch("/path/to/resource/123", page: 5)).to eql response_data
+    end
+  end
+
+  describe API, "#delete" do
+    let(:client) { Object.new.extend(API) }
+
+    before do
+      client.api_token = "MY-API-TOKEN"
+    end
+
+    it "returns the response data of a DELETE request" do
+      response_data = double
+      expect(client).to receive(:request).
+                        with(:delete, "/path/to/resource/123").
+                        and_return(response_data)
+      expect(client.delete("/path/to/resource/123")).to eql response_data
+    end
+  end
+
+  describe API, "#request" do
+    let(:client) { Object.new.extend(API) }
+
+    before do
+      client.api_token = "MY-API-TOKEN"
+    end
+
+    context "when it is a GET request" do
+      it "performs a get with the params" do
+        expect(RestClient).to receive(:get).
+                              with("https://MY-API-TOKEN:@api.printfection.com/v2/path/to/resource/123", {:params => {:page => 5}, :accept => :json}).
+                              and_return(double(:body => "{}"))
+        client.request(:get, "/path/to/resource/123", page: 5)
+      end
+    end
+
+    context "when it is a POST request" do
+      it "performs a post with the params" do
+        expect(RestClient).to receive(:post).
+                              with("https://MY-API-TOKEN:@api.printfection.com/v2/path/to/resource/123", {page: 5}.to_json, {:accept => :json, :content_type => :json}).
+                              and_return(double(:body => "{}"))
+        client.request(:post, "/path/to/resource/123", {page: 5})
+      end
+    end
+
+    context "when it is a PATCH request" do
+      it "performs a patch with the params" do
+        expect(RestClient).to receive(:patch).
+                              with("https://MY-API-TOKEN:@api.printfection.com/v2/path/to/resource/123", {page: 5}.to_json, {:accept => :json, :content_type => :json}).
+                              and_return(double(:body => "{}"))
+        client.request(:patch, "/path/to/resource/123", {page: 5})
+      end
+    end
+
+    context "when it is a DELETE request" do
+      it "performs a delete on the uri" do
+        expect(RestClient).to receive(:delete).
+                              with("https://MY-API-TOKEN:@api.printfection.com/v2/path/to/resource/123").
+                              and_return(double(:body => "{}"))
+        client.request(:delete, "/path/to/resource/123")
+      end
+    end
+
+    context "when it is successful" do
+      let(:raw_json)    { double(:raw_json) }
+      let(:response)    { double(:response, :body => raw_json) }
+      let(:parsed_json) { double(:parsed_json).as_null_object }
+
+      before do
+        allow(RestClient).to receive(:get).
+          with("https://MY-API-TOKEN:@api.printfection.com/v2/path/to/resource/123", {:params => {:page => 5}, :accept => :json}).
+          and_return(response)
+      end
+
+      context "when it can be parsed" do
+        before do
+          allow(JSON).to receive(:parse).
+            with(raw_json).
+            and_return(parsed_json)
+        end
+
+        it "returns the parsed JSON" do
+          json = client.request(:get, "/path/to/resource/123", page: 5)
+          expect(json).to eql parsed_json
+        end
+      end
+
+      context "when it is a list object" do
+        let(:list_element1) { double }
+        let(:list_element2) { double }
+
+        let(:parsed_json_list_object) do
+          {
+            "object" => "list",
+            "data" => [
+              list_element1,
+              list_element2
+            ]
+          }
+        end
+
+        before do
+          allow(JSON).to receive(:parse).
+            with(raw_json).
+            and_return(parsed_json_list_object)
+        end
+
+        it "returns the data property from the parsed json" do
+          json = client.request(:get, "/path/to/resource/123", page: 5)
+          expect(json).to eql [list_element1, list_element2]
+        end
+      end
+
+      context "when it cannot be parsed" do
+        before do
+          allow(JSON).to receive(:parse).
+            with(raw_json).
+            and_raise(JSON::ParserError)
+        end
+
+        it "raises Error" do
+          expect {
+            client.request(:get, "/path/to/resource/123", page: 5)
+          }.to raise_error Printfection::Error
+        end
+      end
+    end
+
+    context "when it is not successful" do
+      context "when it is a known http status code" do
+        it "raises an Error with the appropriate message" do
+          response = double(:response, code: 400, body: '{"message":"Invalid or missing request parameters."}')
+          allow(RestClient).to receive(:get).and_raise(RestClient::Exception.new(response))
+          expect { client.request(:get, "/path/to/resource/123") }.to raise_error Printfection::Error, "Invalid or missing request parameters."
+
+          response = double(:response, code: 401, body: '{"message":"Invalid API key provided."}')
+          allow(RestClient).to receive(:get).and_raise(RestClient::Exception.new(response))
+          expect { client.request(:get, "/path/to/resource/123") }.to raise_error Printfection::Error, "Invalid API key provided."
+
+          response = double(:response, code: 404, body: '{"message":"Not Found."}')
+          allow(RestClient).to receive(:get).and_raise(RestClient::Exception.new(response))
+          expect { client.request(:get, "/path/to/resource/123") }.to raise_error Printfection::Error, "Not Found."
+        end
+      end
+
+      context "when it is an unknown http status code" do
+        it "raises an Error with a generic message" do
+          allow(RestClient).to receive(:get).
+            and_raise(RestClient::Exception)
+          expect {
+            client.request(:get, "/path/to/resource/123")
+          }.to raise_error Printfection::Error, "Something went wrong with the request. Please try again."
+        end
+      end
+
+      context "when an unknown exception is raised" do
+        it "raises an Error with a generic message" do
+          allow(RestClient).to receive(:get).
+            and_raise(StandardError)
+          expect {
+            client.request(:get, "/path/to/resource/123")
+          }.to raise_error Printfection::Error, "Something went wrong. Please try again."
+        end
+      end
+    end
+  end
+end
+

data/spec/asset_spec.rb

@@ -0,0 +1,30 @@
+require 'printfection'
+
+module Printfection
+  describe Asset, "properties" do
+    let(:json) do
+      JSON.parse <<-JSON
+        {
+          "id": 1,
+          "object": "asset",
+          "type": "display",
+          "name": "AA-WhiteLogo-Front.png",
+          "perspective": "front",
+          "url": "https://img.printfection.com/18/26/234234lkajsdfdsf7/AA-WhiteLogo-Front.png",
+          "notes": ""
+        }
+      JSON
+    end
+
+    it "gives access to JSON properties" do
+      asset = Asset.new(json)
+      expect(asset.id).to eql 1
+      expect(asset.type).to eql "display"
+      expect(asset.name).to eql "AA-WhiteLogo-Front.png"
+      expect(asset.perspective).to eql "front"
+      expect(asset.url).to eql "https://img.printfection.com/18/26/234234lkajsdfdsf7/AA-WhiteLogo-Front.png"
+      expect(asset.notes).to eql ""
+    end
+  end
+end
+

data/spec/campaign_spec.rb

@@ -0,0 +1,44 @@
+require 'printfection'
+
+module Printfection
+  describe Campaign do
+    it_behaves_like "Resource"
+    include_examples "Actions::Retrieve"
+    include_examples "Actions::List"
+  end
+
+  describe Campaign, ".uri" do
+    it "returns the base resource uri" do
+      expect(Campaign.uri).to eql "/campaigns"
+    end
+  end
+
+  describe Campaign, "properties" do
+    let(:json) do
+      JSON.parse <<-JSON
+        {
+          "id": 1,
+          "object": "campaign",
+          "type": "giveaway",
+          "name": "My Awesome Giveaway Campaign",
+          "active": true,
+          "archived": false,
+          "url": "https://get.printfection.com/i8kbn/6651657281",
+          "created_at": "2014-09-12T10:22:37Z"
+        }
+      JSON
+    end
+
+    it "gives access to JSON properties" do
+      campaign = Campaign.new(json)
+      expect(campaign.id).to eql 1
+      expect(campaign.type).to eql "giveaway"
+      expect(campaign.name).to eql "My Awesome Giveaway Campaign"
+      expect(campaign.active).to eql true
+      expect(campaign.archived).to eql false
+      expect(campaign.url).to eql "https://get.printfection.com/i8kbn/6651657281"
+      expect(campaign.created_at).to eql DateTime.parse("2014-09-12T10:22:37Z")
+    end
+  end
+end
+

data/spec/item_spec.rb

@@ -0,0 +1,118 @@
+require 'printfection'
+
+module Printfection
+  describe Item do
+    it_behaves_like "Resource"
+    include_examples "Actions::Retrieve"
+    include_examples "Actions::List"
+  end
+
+  describe Item, ".uri" do
+    it "returns the base resource uri" do
+      expect(Item.uri).to eql "/items"
+    end
+  end
+
+  describe Item, "properties" do
+    let(:json) do
+      JSON.parse <<-JSON
+        {
+          "id": 1,
+          "object": "item",
+          "name": "My Awesome T-Shirt",
+          "color": "Green",
+          "product": {
+            "id": 123,
+            "name": "American Apparel 50/50 T-Shirt"
+          },
+          "created_at": "2014-09-12T10:22:37Z",
+          "campaigns": [
+            {
+              "id": 1,
+              "object": "campaign",
+              "type": "giveaway",
+              "name": "My Awesome Giveaway Campaign",
+              "active": true,
+              "archived": false,
+              "url": "https://get.printfection.com/i8kbn/6651657281",
+              "created_at": "2014-09-12T10:22:37Z"
+            },
+            {
+              "id": 2,
+              "object": "campaign",
+              "type": "giveaway",
+              "name": "My Other Giveaway Campaign",
+              "active": false,
+              "archived": true,
+              "url": "https://get.printfection.com/i8kbn/6651657282",
+              "created_at": "2014-09-11T10:22:37Z"
+            }
+          ],
+          "sizes": [
+            {
+              "id": 1,
+              "object": "size",
+              "name": "Medium",
+              "short_name": "M",
+              "stock": {
+                "available": 498
+              }
+            },
+            {
+              "id": 2,
+              "object": "size",
+              "name": "Large",
+              "short_name": "L",
+              "stock": {
+                "available": 996
+              }
+            }
+          ],
+          "assets": [
+            {
+              "id": 1,
+              "object": "asset",
+              "type": "display",
+              "name": "AA-WhiteLogo-Front.png",
+              "perspective": "front",
+              "url": "https://img.printfection.com/18/26/234234lkajsdfdsf7/AA-WhiteLogo-Front.png",
+              "notes": ""
+            },
+            {
+              "id": 2,
+              "object": "asset",
+              "type": "display",
+              "name": "AA-WhiteLogo-Back.png",
+              "perspective": "back",
+              "url": "https://img.printfection.com/18/26/234234lkajsdfdsf7/AA-WhiteLogo-Back.png",
+              "notes": ""
+            }
+          ]
+        }
+      JSON
+    end
+
+    it "gives access to JSON properties" do
+      item = Item.new(json)
+      expect(item.id).to eql 1
+      expect(item.name).to eql "My Awesome T-Shirt"
+      expect(item.color).to eql "Green"
+      expect(item.created_at).to eql DateTime.parse("2014-09-12T10:22:37Z")
+
+      expect(item.product).to be_a Product
+
+      expect(item.campaigns).to be_an Array
+      expect(item.campaigns.count).to eql 2
+      expect(item.campaigns.first).to be_a Campaign
+
+      expect(item.sizes).to be_an Array
+      expect(item.sizes.count).to eql 2
+      expect(item.sizes.first).to be_a Size
+
+      expect(item.assets).to be_an Array
+      expect(item.assets.count).to eql 2
+      expect(item.assets.first).to be_a Asset
+    end
+  end
+end
+