representors 0.0.5

data/spec/lib/representors/representor_spec.rb

@@ -0,0 +1,285 @@
+require 'spec_helper'
+require 'yaml'
+require 'uri'
+
+module Representors
+  describe Representor do
+    let(:base_doc) {'A list of DRDs.'}
+    let(:rel_first_transition) {'self'}
+    let(:rel_second_transition) {'search'}
+    before do
+      @base_representor = {
+        protocol: 'http',
+        href: 'www.example.com/drds',
+        id: 'drds',
+        doc: base_doc,
+        attributes: {},
+        embedded: {},
+        links: {},
+        transitions: []
+      }
+
+      @semantic_elements = {
+        attributes: {
+          total_count: {
+            doc: 'The total count of DRDs.',
+            type: 'semantic',
+            profile: 'http://alps.io/schema.org/Integer',
+            sample: 1,
+            value: 2
+          },
+          uptime: {
+            value: '76ms'
+          },
+          brackreference: {
+            value: 886396728
+          }
+        }
+      }
+
+      @transition_elements = {
+        transitions: [
+          {
+            doc: 'Returns a list of DRDs.',
+            rt: 'drds',
+            type: 'safe',
+            href: 'some.example.com/list',
+            rel: rel_first_transition
+          },
+          {
+            doc: 'Returns a list of DRDs that satisfy the search term.',
+            rt: 'drds',
+            type: 'safe',
+            href: '/',
+            rel: rel_second_transition,
+            descriptors: {
+              name: {
+                doc: "Name to search",
+                profile: "http://alps.io/schema.org/Text",
+                sample: "drdname",
+                options: {'list' => ['one', 'two']}
+              },
+              status: {
+                doc: "How is the DRD.",
+                profile: "http://alps.io/schema.org/Text",
+                sample: "renegade",
+                options: {'list' => ['renegade', 'compliant'], 'id' => 'status_list'}
+              }
+            }
+          }
+        ]
+      }
+    end
+    let(:representor_hash) { @representor_hash || @base_representor }
+    let(:subject) { Representor.new(representor_hash) }
+
+    describe '.new' do
+      it 'returns a Representors::Representor instance' do
+        expect(subject).to be_an_instance_of(Representor)
+      end
+
+      it 'yields a builder' do
+        Representor.new do |builder|
+          expect(builder).to be_an_instance_of(RepresentorBuilder)
+          builder
+        end
+      end
+
+      it 'returns a Representors::Representor instance with a nil argument' do
+        expect(Representor.new).to be_an_instance_of(Representor)
+      end
+
+      describe '#to_s' do
+        it 'retuns a string representation' do
+          expect(eval(subject.to_s)).to eq(representor_hash)
+        end
+      end
+
+      describe '#doc' do
+        context 'the hash has a doc' do
+          let(:doc) {base_doc}
+          it 'returns the same value specified under the doc element of the hash' do
+            @representor_hash = RepresentorHash.new
+            @representor_hash.doc = doc
+            expect(subject.doc).to eq(doc)
+          end
+        end
+        context 'the hash has non doc' do
+          it 'returns an empty string' do
+            @representor_hash = RepresentorHash.new
+            expect(subject.doc).to eq('')
+          end
+        end
+      end
+
+      describe '#identifier' do
+        context 'href and protocol are specified' do
+          let(:href) { 'www.example.com/drds'}
+          let(:protocol) {'http'}
+          it 'returns an url' do
+            @representor_hash = RepresentorHash.new(protocol: protocol, href: href)
+            expect(subject.identifier).to match(URI::regexp)
+          end
+        end
+
+        context 'href is not specified and protocol is specified' do
+          let(:protocol) {'http'}
+          it 'returns an url with object id' do
+            @representor_hash = RepresentorHash.new(protocol: protocol)
+            expect(subject.identifier).to eq('http://%s' % subject.object_id)
+          end
+        end
+
+        context 'href is specified and protocol is not specified' do
+          let(:href) { 'www.example.com/drds'}
+          it 'returns an url with default protocol' do
+            @representor_hash = RepresentorHash.new(href: href)
+            expect(subject.identifier).to eq('http://%s' % href)
+          end
+        end
+
+        context 'href is not specified and protocol is not specified' do
+          let(:href) { 'www.example.com/drds'}
+          it 'returns an unknown protocol object url' do
+            @representor_hash = RepresentorHash.new
+            expect(subject.identifier).to eq("ruby_id://%s" % subject.object_id)
+          end
+        end
+
+      end
+
+      describe '#to_hash' do
+        it 'returns a hash that it can be reconstructed with' do
+          expect(Representor.new(subject.to_hash).to_hash).to eq(@base_representor)
+        end
+      end
+
+      describe '#to_yaml' do
+        it 'returns a yaml file that represents its internal hash' do
+          expect(YAML.load(subject.to_yaml)).to eq(@base_representor)
+        end
+      end
+
+      describe '#properties' do
+        it 'returns a hash of attributes associated with the represented resource' do
+          @representor_hash =  @base_representor.merge(@semantic_elements)
+          semantic_elements_present =  %w(total_count uptime brackreference).all? do |key|
+            subject.properties[key.to_sym] == @semantic_elements[:attributes][key.to_sym][:value]
+          end
+          expect(semantic_elements_present).to eq(true)
+         end
+       end
+
+      describe '#embedded' do
+        let(:embedded_resource) {'embedded_resource'}
+        let(:profile_link) { {profile: "http://alps.io/schema.org/Thing"} }
+
+        before do
+          @count = 3
+          @representor_hash = RepresentorHash.new(@base_representor).merge(@semantic_elements)
+          embedded_resources = []
+
+          @transitions_hash = {
+              transitions: [
+                  { doc: 'Returns a list of DRDs',
+                    type: 'safe',
+                    rel: 'self'
+                  }
+              ]
+            }
+
+          @count.times do |i|
+            transitions_hash = deep_dup(@transitions_hash)
+            transitions_hash[:transitions][0][:href] = "some.example.com/list/#{i}"
+            embedded_item = deep_dup(@representor_hash).merge(transitions_hash)
+            embedded_item[:links] = profile_link if i == 0
+            embedded_resources << embedded_item
+          end
+
+
+          @representor_hash[:embedded] = { embedded_resource => embedded_resources }
+        end
+
+        it 'returns a set of Representor objects' do
+          expect(subject.embedded[embedded_resource].first).to be_an_instance_of(Representors::Representor)
+        end
+
+        it 'returns a Representor objects that has its data' do
+          embedded_objects_valid = subject.embedded[embedded_resource].all? { |embed| embed.doc == base_doc }
+          expect(embedded_objects_valid).to eq(true)
+        end
+
+        it 'returns the all the Representors' do
+          expect(subject.embedded[embedded_resource].count).to eq(@count)
+        end
+
+        it 'doesn\'t blow up even if nothing is embedded' do
+          @representor_hash = @base_representor
+          expect(subject.embedded.count).to eq(0)
+        end
+
+        it 'includes appropriate profile links if it exists' do
+          expect(subject.transitions.first[:profile]).to eq(profile_link["profile"])
+          expect(subject.transitions[1][:profile]).to be_nil
+          expect(subject.transitions.last[:profile]).to be_nil
+        end
+      end
+
+      describe '#transitions' do
+        it 'returns all transitions' do
+          @representor_hash =  @base_representor.merge(@transition_elements)
+          expect(subject.transitions.size).to eq(2)
+          has_transitions = subject.transitions.all? { |trans| trans.instance_of?(Transition) }
+          expect(has_transitions).to eq(true)
+          expect(subject.transitions[0].rel).to eq(rel_first_transition)
+          expect(subject.transitions[1].rel).to eq(rel_second_transition)
+        end
+        context 'with transitions which have the same rel and href' do
+          it 'returns only one transition' do
+            transitions = { transitions: [
+              {
+                doc: 'Returns a list of DRDs.',
+                rt: 'drds',
+                type: 'safe',
+                href: 'some.example.com/list',
+                rel: rel_first_transition
+              },
+              {
+                doc: 'Returns a list of trusmis.',
+                rt: 'trusmis',
+                type: 'unsafe',
+                href: 'some.example.com/list',
+                rel: rel_first_transition
+              }
+            ]
+            }
+          @representor_hash =  @base_representor.merge(transitions)
+          expect(subject.transitions.size).to eq(1)
+          has_transitions = subject.transitions.all? { |trans| trans.instance_of?(Transition) }
+          expect(has_transitions).to eq(true)
+          expect(subject.transitions[0].rel).to eq(rel_first_transition)
+          end
+        end
+      end
+
+      describe '#meta_links' do
+        it 'should return a list of transitions representing those links' do
+          @base_representor[:links] = {
+            self: 'DRDs#drds/create',
+            help: 'Forms/create'
+          }
+          expect(subject.meta_links.size).to eq(2)
+          has_meta_link = subject.meta_links.all? { |trans| trans.instance_of?(Transition) }
+          expect(has_meta_link).to eq(true)
+        end
+      end
+
+      describe '#datalists' do
+        it 'returns all paramters and attributes that are members of a datalist' do
+          @representor_hash =  @base_representor.merge(@transition_elements)
+          has_data_list = expect(subject.datalists.first.to_hash).to eq({"renegade" => "renegade", "compliant" => "compliant"})
+        end
+      end
+    end
+  end
+end

data/spec/lib/representors/serialization/deserializer_factory_spec.rb

@@ -0,0 +1,118 @@
+require 'spec_helper'
+require 'representors/serialization/deserializer_factory'
+
+module Representors
+  describe DeserializerFactory do
+    let(:factory) { Class.new(DeserializerFactory) } # prevent singleton pollution from spec
+
+    describe '.register_deserializers' do
+      it 'adds classes to the registered deserializers' do
+        serializer_classes = [double('deserializer1'), double('deserializer2')]
+        factory.register_deserializers(*serializer_classes)
+
+        expect(factory.registered_deserializers).to include(*serializer_classes)
+      end
+    end
+
+    describe '.registered_deserializers' do
+      before do
+        @deserializer_class = double('deserializer3')
+        factory.register_deserializers(@deserializer_class)
+      end
+
+      it 'memoizes' do
+        registered_deserializers = factory.registered_deserializers.object_id
+
+        expect(registered_deserializers).to eq(factory.registered_deserializers.object_id)
+      end
+
+      it 'returns a frozen list of registered_deserializers' do
+        expect(factory.registered_deserializers).to be_frozen
+      end
+
+      it 'returns registered serializers' do
+        expect(factory.registered_deserializers).to include(@deserializer_class)
+      end
+    end
+
+    describe '#build' do
+      let(:document) { {}.to_json }
+      subject(:deserializer) { DeserializerFactory.build(media_type, document) }
+
+      shared_examples_for 'a built deserializer' do
+        it 'sets the correct target in the deserializer' do
+          expect(deserializer.to_representor_hash).to eq(RepresentorHash.new)
+        end
+      end
+
+      shared_examples_for 'a hal deserializer' do
+        it 'returns a HalDeserializer' do
+          expect(deserializer).to be_instance_of HalDeserializer
+        end
+
+        it_behaves_like 'a built deserializer'
+      end
+
+      context 'with an empty response body' do
+        [nil, '', '{}', ' '].each do |response_body|
+          context "when given a #{response_body.inspect}" do
+            let(:media_type) { 'application/hal+json' }
+            let(:document) { '' }
+
+            it_behaves_like 'a hal deserializer'
+          end
+        end
+      end
+
+      context 'with hal+json media type as a string' do
+        let(:media_type) { 'application/hal+json' }
+
+        it_behaves_like 'a hal deserializer'
+      end
+
+      context 'with hal+json media type as a symbol' do
+        let(:media_type) { :hal }
+
+        it_behaves_like 'a hal deserializer'
+      end
+
+      shared_examples_for 'a hale deserializer' do
+        it 'returns a HaleDeserializer' do
+          expect(deserializer).to be_instance_of HaleDeserializer
+        end
+
+        it_behaves_like 'a built deserializer'
+      end
+
+      context 'with hale+json media type as a string' do
+        let(:media_type) { 'application/vnd.hale+json' }
+
+        it_behaves_like 'a hale deserializer'
+      end
+
+      context 'with hale+json media type as a symbol' do
+        let(:media_type) { :hale }
+
+        it_behaves_like 'a hale deserializer'
+      end
+
+      shared_examples_for 'an unknown media type' do
+        it 'raises an unknown media type error' do
+          expect { deserializer }.to raise_error(UnknownMediaTypeError, "Unknown media-type: #{media_type}.")
+        end
+      end
+
+      context 'unknown media type string' do
+        let(:media_type) { 'unknown' }
+
+        it_behaves_like 'an unknown media type'
+      end
+
+      context 'unknown media type symbol' do
+        let(:media_type) { :unknown }
+
+        it_behaves_like 'an unknown media type'
+      end
+    end
+  end
+end

data/spec/lib/representors/serialization/hal_deserializer_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Representors::HalDeserializer do
+
+  it "initializes with a JSON document" do
+    expect(Representors::HalDeserializer.new({}.to_json)).to be_instance_of(Representors::HalDeserializer)
+  end
+
+  it 'provides the media-type application/vnd.hal+json' do
+    formats = Representors::HalDeserializer.media_types
+    expect(formats).to include('application/hal+json', 'application/json')
+  end
+
+  it 'provides the media symbol :hal' do
+    expect(Representors::HalDeserializer.media_symbols).to include(:hal)
+  end
+
+  describe "#to_representor" do
+    it_behaves_like 'can create a representor from a hal document' do
+      subject(:deserializer) {Representors::HalDeserializer.new(document)}
+    end
+    
+    context "when the Hal deserializer recieves a Hale document" do
+      it "deserializes as a Hal document and not a Hale document" do
+        file = File.read("#{SPEC_DIR}/fixtures/hale_tutorial_examples/meta.json")
+        hal_rep = Representors::HalDeserializer.new(file).to_representor
+        place_order_link_data = hal_rep.transitions.find { |t| t[:rel] == "place_order" }
+        expect(hal_rep.properties.keys).to include('_meta')
+        expect(place_order_link_data.interface_method).to eq('GET')
+      end
+    end
+  end
+  
+end

data/spec/lib/representors/serialization/hal_serializer_spec.rb

@@ -0,0 +1,171 @@
+require 'spec_helper'
+require 'yaml'
+require 'uri'
+
+module Representors
+  describe Serialization::HalSerializer do
+
+    subject(:serializer) { SerializerFactory.build(:hal_json, Representor.new(document)) }
+    let(:result) {JSON.parse(serializer.to_media_type)}
+    let(:base_representor) do
+      {
+         protocol: 'http',
+         href: 'www.example.com/drds',
+         id: 'drds',
+         doc: 'doc'
+      }
+    end
+
+    shared_examples 'a hal documents attributes' do |representor_hash|
+      let(:document) { representor_hash.merge(base_representor) }
+
+      representor_hash[:attributes].each do |k, v|
+        it "includes the document attribute #{k} and associated value" do
+          expect(result[k]).to eq(v[:value])
+        end
+      end
+    end
+
+    shared_examples 'a hal documents links' do |representor_hash|
+      let(:document) { representor_hash.merge(base_representor) }
+
+      representor_hash[:transitions].each do |item|
+        it "includes the document transition #{item}" do
+          links = result['_links']
+          link = links[item[:rel]]
+          expect(link['href']).to eq(item[:href])
+        end
+      end
+    end
+
+    shared_examples 'a hal documents embedded hal documents' do |representor_hash|
+      let(:document) { representor_hash.merge(base_representor) }
+
+      representor_hash[:embedded].each do |embed_name, embed|
+        embed[:attributes].each do |k, v|
+          it "includes the document attribute #{k} and associated value" do
+            expect(result['_embedded'][embed_name][k]).to eq(v[:value])
+          end
+        end
+        embed[:transitions].each do |item|
+          it "includes the document attribute #{item} and associated value" do
+            expect(result['_embedded'][embed_name]['_links'][item[:rel]]['href']).to eq(item[:href])
+          end
+        end
+      end
+    end
+
+    shared_examples 'a hal documents embedded collection' do |representor_hash|
+      let(:document) { representor_hash.merge(base_representor) }
+
+      representor_hash[:embedded].each do |embed_name, embeds|
+        embeds.each_with_index do |embed, index|
+          embed[:attributes].each do |k, v|
+            it "includes the document attribute #{k} and associated value" do
+              expect(result['_embedded'][embed_name][index][k]).to eq(v[:value])
+            end
+          end
+          embed[:transitions].each do |item|
+            it "includes the document attribute #{item} and associated value" do
+              expect(result['_embedded'][embed_name][index]['_links'][item[:rel]]['href']).to eq(item[:href])
+            end
+          end
+        end
+      end
+    end
+
+    describe '#as_media_type' do
+      context 'empty document' do
+        let(:document) { {} }
+
+        it 'returns a hash with no attributes, links or embedded resources' do
+          empty_json_document = '{}'
+          expect(serializer.to_media_type).to eq(empty_json_document)
+        end
+      end
+
+      context 'Document with only properties' do
+        representor_hash = begin
+          {
+            attributes: {
+              'title' => {value: 'The Neverending Story'},
+              'author' => {value: 'Michael Ende'},
+              'pages' => {value: '396'}
+            }
+          }
+        end
+
+        it_behaves_like 'a hal documents attributes', representor_hash
+      end
+
+      context 'Document with properties and links' do
+        representor_hash = begin
+          {
+            attributes: {
+              'title' => {value: 'The Neverending Story'},
+            },
+            transitions: [
+              {
+                href: '/mike',
+                rel: 'author',
+              }
+            ]
+          }
+        end
+
+        it_behaves_like 'a hal documents attributes', representor_hash
+        it_behaves_like 'a hal documents links', representor_hash
+      end
+
+      context 'Document with properties, links, and embedded' do
+        representor_hash = begin
+          {
+            attributes: {
+              'title' => {value: 'The Neverending Story'},
+            },
+            transitions: [
+              {
+                href: '/mike',
+                rel: 'author',
+              }
+            ],
+            embedded: {
+              'embedded_book' => {attributes: {'content' => { value: 'A...' } }, transitions: [{rel: 'self', href: '/foo'}]}
+            }
+          }
+        end
+
+        it_behaves_like 'a hal documents attributes', representor_hash
+        it_behaves_like 'a hal documents links', representor_hash
+        it_behaves_like 'a hal documents embedded hal documents', representor_hash
+      end
+
+      context 'Document with an embedded collection' do
+        representor_hash = begin
+          {
+            attributes: {
+              'title' => {value: 'The Neverending Story'},
+            },
+            transitions: [
+              {
+                href: '/mike',
+                rel: 'author',
+              }
+            ],
+            embedded: {
+              'embedded_book' => [
+                {attributes: {'content' => { value: 'A...' } }, transitions: [{rel: 'self', href: '/foo1'}]},
+                {attributes: {'content' => { value: 'B...' } }, transitions: [{rel: 'self', href: '/foo2'}]},
+                {attributes: {'content' => { value: 'C...' } }, transitions: [{rel: 'self', href: '/foo3'}]}
+              ]
+            }
+          }
+        end
+
+        it_behaves_like 'a hal documents attributes', representor_hash
+        it_behaves_like 'a hal documents links', representor_hash
+        it_behaves_like 'a hal documents embedded collection', representor_hash
+      end
+    end
+  end
+end