subjoin 0.2.1

data/spec/inheritable_resource_spec.rb

@@ -0,0 +1,89 @@
+require "spec_helper"
+
+module Subjoin
+  class ExampleResource < Resource
+    include Inheritable
+    ROOT_URI="http://example.com"
+  end
+
+  class NonStandardUri < ExampleResource
+    TYPE_PATH="nonstandard"
+  end
+
+  class Articles < ExampleResource
+    #TYPE_PATH="articles"
+  end
+
+  class ExamplePerson < ExampleResource
+    TYPE_PATH="people"
+  end
+
+end
+
+describe Subjoin::Inheritable do
+  before :each do
+    allow_any_instance_of(Faraday::Connection).
+      to receive(:get).and_return(double(Faraday::Response, :body => ARTICLE))
+  end
+  
+  it "has a root uri" do
+    expect(Subjoin::ExampleResource::ROOT_URI).to eq "http://example.com"
+  end
+  
+  describe "#type_url" do
+    it "is a class method" do
+      expect(Subjoin::ExampleResource::type_url).to eq URI("http://example.com/exampleresource")
+    end
+  end
+end
+
+describe Subjoin::Document do
+  describe "#new" do
+    context "with a single string parameter" do
+      it "maps derived types" do
+        expect_any_instance_of(Faraday::Connection)
+          .to receive(:get).with(URI("http://example.com/articles"), {}, Hash)
+               .and_return(double(Faraday::Response, :body => ARTICLE))
+        Subjoin::Document.new("articles")
+      end
+
+      it "returns objects of the right class" do
+        expect_any_instance_of(Faraday::Connection).
+          to receive(:get).
+              and_return(double(Faraday::Response, :body => COMPOUND))
+
+        expect(Subjoin::Document.new("articles").data.first).
+          to be_an_instance_of Subjoin::Articles
+      end
+
+      it "returns included objects of the right class" do
+        expect_any_instance_of(Faraday::Connection).
+          to receive(:get).
+              and_return(double(Faraday::Response, :body => COMPOUND))
+        expect(Subjoin::Document.new("articles").data.first.
+                rels["author"].first).
+          to be_an_instance_of Subjoin::ExamplePerson
+      end
+
+      it "returns Resource objects when there is no mapped type" do
+        expect_any_instance_of(Faraday::Connection).
+          to receive(:get).
+              and_return(double(Faraday::Response, :body => COMPOUND))
+        expect(Subjoin::Document.new("articles").data.first.
+                rels["comments"].first).
+          to be_an_instance_of Subjoin::Resource
+      end
+    end
+
+    context "with two string parameters" do
+      it "maps derived types with the second string as an id" do
+        expect_any_instance_of(Faraday::Connection)
+          .to receive(:get).with(URI("http://example.com/articles/2"), {}, Hash)
+               .and_return(double(Faraday::Response, :body => ARTICLE))
+        Subjoin::Document.new("articles", "2")
+      end
+    end
+  end
+end
+
+  

data/spec/link_spec.rb

@@ -0,0 +1,60 @@
+require "spec_helper"
+
+describe Subjoin::Link do
+  context "initialization with a string" do
+    before :each do
+      @link = Subjoin::Link.new(JSON.parse(LINKS)["self"])
+    end
+
+    it "should have an href attribute" do
+      expect(@link.href.to_s).to eq "http://example.com/posts"
+    end
+
+    it "should have a nil meta attribute" do
+      expect(@link.meta).to be_nil
+    end
+  end
+
+  context "initialization with an object" do
+    before :each do
+      @link = Subjoin::Link.new(JSON.parse(LINKS)["related"])
+    end
+
+    it "should have an href attribute" do
+      expect(@link.href.to_s).to eq "http://example.com/articles/1/comments"
+    end
+
+    context "when there is a meta attribute" do
+      it "should have a meta attribute" do
+        expect(@link.meta).to be_an_instance_of Subjoin::Meta
+      end
+    end
+
+    context "when there is no meta attribute" do
+      it "should not have a meta attribute" do
+        metaless = JSON.parse(LINKS)["related"]
+        metaless.delete("meta")
+        expect(Subjoin::Link.new(metaless).meta).to be_nil
+      end
+    end
+  end
+
+  describe "#has_meta?" do
+    it "should be false if there is no meta attribute" do
+      expect(Subjoin::Link.new(JSON.parse(LINKS)["self"]).has_meta?).
+        to eq false
+    end
+
+    it "should be true if there is a meta attribute" do
+      expect(Subjoin::Link.new(JSON.parse(LINKS)["related"]).has_meta?).
+        to eq true
+    end
+  end
+
+  describe "#to_s" do
+    it "should return the href" do
+      @l = Subjoin::Link.new(JSON.parse(LINKS)["self"])
+      expect("#{@l}").to eq "http://example.com/posts"
+    end
+  end
+end

data/spec/meta_spec.rb

@@ -0,0 +1,11 @@
+require "spec_helper"
+
+describe "Subjoin::Meta" do
+  before :each do
+    @m = Subjoin::Meta.new(JSON.parse(META)['meta'])
+  end
+
+  it "has dynamic attributes" do
+    expect(@m["copyright"]).to eq "Copyright 2015 Example Corp."
+  end
+end

data/spec/relationship_spec.rb

@@ -0,0 +1,64 @@
+require "spec_helper"
+
+
+describe Subjoin::Relationship do
+  before :all do
+    @doc = Subjoin::Document.new(JSON.parse(COMPOUND))
+    @auths = @doc.data.first.relationships["author"]
+  end
+
+  it "is linkable" do
+    expect(@auths.links.map{|k,v| v.class}.uniq).to eq [Subjoin::Link]
+  end
+
+  it "has the right links" do
+    expect(@auths.links.keys).to eq ["self", "related"]
+  end
+
+  it "has a meta object" do
+    expect(@auths.meta).to be_an_instance_of Subjoin::Meta
+  end
+
+  describe "#lookup" do
+    it "returns an Array of resources" do
+      expect(@auths.lookup.map{|o| o.class}.uniq).to eq [Subjoin::Resource]
+    end
+  end
+
+  describe "#linkages" do
+    context "with a single linkage" do
+      it "returns an Array" do
+        expect(@auths.linkages).to be_an_instance_of Array
+      end
+
+      it "returns an array with a single member" do
+        expect(@auths.linkages.count).to eq 1
+      end
+        
+      it "returns an array of Identifier objects" do
+        expect(@auths.linkages.map{|l| l.class}.uniq).to eq [Subjoin::Identifier]
+      end
+    end
+
+    context "with an array of linkages" do
+      before :each do
+        @comments = Subjoin::Relationship.new(
+          JSON.parse(ARTICLE)['data']['relationships']['comments'],
+          nil
+        )
+      end      
+
+      it "returns an Array" do
+        expect(@comments.linkages).to be_an_instance_of Array
+      end
+
+      it "returns an array with more than 1 member" do
+        expect(@comments.linkages.count).to be > 1
+      end
+        
+      it "returns an array of Identifier objects" do
+        expect(@comments.linkages.map{|l| l.class}.uniq).to eq [Subjoin::Identifier]
+      end
+    end
+  end
+end

data/spec/resource_spec.rb

@@ -0,0 +1,139 @@
+require "spec_helper"
+
+class Base < Subjoin::Resource
+  def self.root
+    "http://example.com"
+  end
+end
+
+class Article < Base
+end
+
+describe Subjoin::Resource do
+  before :each do
+    allow_any_instance_of(Faraday::Connection).
+      to receive(:get).and_return(double(Faraday::Response, :body => ARTICLE))
+  end
+
+  context "using instance methods to retrieve single resources" do
+    describe "#initialize" do
+      context "passing a URI as a parameter" do
+        it "should get the same a parameter" do
+          expect_any_instance_of(Faraday::Connection)
+            .to receive(:get).
+                 with(URI("http://example.com/articles/2"), {}, Hash).
+                 and_return(double(Faraday::Response, :body => ARTICLE))
+
+          @articles = Subjoin::Resource.
+                      new(URI("http://example.com/articles/2"))
+          
+        end
+
+        it "should raise an error if the response is not a single object" do
+          expect_any_instance_of(Faraday::Connection)
+            .to receive(:get)
+                 .and_return(double(Faraday::Response, :body => COMPOUND))
+          expect { Subjoin::Resource.
+                   new(URI("http://example.com/articles")) }
+            .to raise_error(Subjoin::UnexpectedTypeError)
+        end
+      end
+
+      context "passing a hash as a parameter" do
+        it "should succeed" do
+          expect(Subjoin::Resource.new(JSON.parse(ARTICLE)).id).to eq "1"
+        end
+      end
+    end
+  end
+
+  describe "simple methods" do
+    before :each do
+      @article = Subjoin::Resource.new(URI("http://example.com/articles/1"))
+    end
+
+    it "should have an id" do
+      expect(@article.id).to eq "1"
+    end
+
+    it "should have a type" do
+      expect(@article.type).to eq "articles"
+    end
+
+    it "should have automatic attributes" do
+      expect(@article["title"]).to eq "JSON API paints my bikeshed!"
+    end
+  end
+
+  describe "#links" do
+    before :each do
+      @article = Subjoin::Resource.new(URI("http://example.com/articles/1"))
+    end
+
+    context "with no parameter" do
+      it "returns a Hash of all the links" do
+        expect(@article.links.map{|k,v| v.class}.uniq).to eq [Subjoin::Link]
+      end
+    end
+
+    context "with a parameter" do
+      it "returns a link object" do
+        expect(@article.links["self"]).to be_an_instance_of Subjoin::Link
+      end
+    end
+  end
+
+  describe "#rels" do
+    context "when there are included resources" do
+      before :each do
+        allow_any_instance_of(Faraday::Connection).
+          to receive(:get).
+              and_return(double(Faraday::Response, :body => COMPOUND))
+        @article = Subjoin::Document.new(URI("http://example.com/articles/1")).
+                   data.first
+      end
+      
+      context "called with no parameters" do
+        it "returns a Hash of Arrays of Relationship objects" do
+          expect(@article.rels.map{|k, r| r}.flatten.map{|r| r.class}.uniq).
+            to eq [Subjoin::Resource]
+        end
+      end
+      
+      context "called with a spec parameter" do
+        it "returns an array" do
+          expect(@article.rels("author").map{|r| r.class}).
+            to eq [Subjoin::Resource]
+        end
+      end
+    end
+
+    context "when there are no included resources" do
+      before :each do
+        @article = Subjoin::Resource.new(URI("http://example.com/articles/1"))
+      end
+      
+      context "called with no spec parameter" do
+        it "returns nil" do
+          expect(@article.rels).to be_nil
+        end
+      end
+
+      context "called with a spec parameter" do
+        it "returns nil" do
+          expect(@article.rels("author")).to be_nil
+        end
+      end
+    end
+  end
+
+  describe "#meta" do
+    before :each do
+      @article = Subjoin::Resource.new(URI("http://example.com/articles/1"))
+    end
+
+    it "returns a Meta object" do
+      expect(@article.meta).to be_an_instance_of Subjoin::Meta
+    end
+  end
+end

data/spec/responses/404.json

@@ -0,0 +1,8 @@
+{
+    "errors": [
+        {
+            "title": "Resource Not Found",
+            "status": 404
+        }
+    ]
+}

data/spec/responses/article_example.json

@@ -0,0 +1,37 @@
+{
+  "data": {
+    "type": "articles",
+    "id": "1",
+    "attributes": {
+      "title": "JSON API paints my bikeshed!"
+    },
+    "links": {
+      "self": "http://example.com/articles/1"
+    },
+    "relationships": {
+      "author": {
+        "links": {
+          "self": "http://example.com/articles/1/relationships/author",
+          "related": "http://example.com/articles/1/author"
+        },
+        "data": { "type": "people", "id": "9" },
+        "meta":	{
+            "explanation": "Who wrote the article"
+        }
+      },
+      "comments": {
+        "links": {
+          "self": "http://example.com/articles/1/relationships/comments",
+          "related": "http://example.com/articles/1/comments"
+        },
+        "data": [
+          { "type": "comments", "id": "5" },
+          { "type": "comments", "id": "12" }
+        ]
+      }
+    },
+    "meta": {
+      "reason": "To have an example meta object"
+    }
+  }
+}

data/spec/responses/compound_example.json

@@ -0,0 +1,73 @@
+{
+  "data": [{
+    "type": "articles",
+    "id": "1",
+    "attributes": {
+      "title": "JSON API paints my bikeshed!"
+    },
+    "links": {
+      "self": "http://example.com/articles/1"
+    },
+    "relationships": {
+      "author": {
+        "links": {
+          "self": "http://example.com/articles/1/relationships/author",
+          "related": "http://example.com/articles/1/author"
+        },
+        "data": { "type": "people", "id": "9" },
+        "meta":	{
+            "explanation": "Who wrote the article"
+        }
+      },
+      "comments": {
+        "links": {
+          "self": "http://example.com/articles/1/relationships/comments",
+          "related": "http://example.com/articles/1/comments"
+        },
+        "data": [
+          { "type": "comments", "id": "5" },
+          { "type": "comments", "id": "12" }
+        ]
+      }
+    }
+  }],
+  "included": [{
+    "type": "people",
+    "id": "9",
+    "attributes": {
+      "first-name": "Dan",
+      "last-name": "Gebhardt",
+      "twitter": "dgeb"
+    },
+    "links": {
+      "self": "http://example.com/people/9"
+    }
+  }, {
+    "type": "comments",
+    "id": "5",
+    "attributes": {
+      "body": "First!"
+    },
+    "links": {
+      "self": "http://example.com/comments/5"
+    }
+  }, {
+    "type": "comments",
+    "id": "12",
+    "attributes": {
+      "body": "I like XML better"
+    },
+    "links": {
+      "self": "http://example.com/comments/12"
+    }
+  }],
+  "links": {
+    "related": "http://jsonapi.org"
+  },
+  "meta": {
+    "category": "Example response"
+  },
+  "jsonapi": {
+    "version": "1.0"
+  }
+}