representors 0.0.5

data/spec/spec_helper.rb

@@ -0,0 +1,32 @@
+unless ENV['MUTANT']
+  require 'simplecov'
+  SimpleCov.start
+end
+
+SPEC_DIR = File.expand_path("..", __FILE__)
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'representors'
+
+Dir["#{SPEC_DIR}/support/*.rb"].each { |f| require f }
+
+def create_serializer(name)
+  Class.new(Representors::SerializerBase) do |klass|
+    klass.media_symbol name.to_sym
+    klass.media_type name
+  end
+end
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random' unless ENV['RANDOMIZE'] == 'false'
+
+  config.include Support::Helpers
+  config.include RepresentorSupport::Utilities
+end

data/spec/support/basic-hale.json

@@ -0,0 +1,12 @@
+{
+   "_meta": {
+   "any": { "json": "object" }
+  },
+  "_links": {
+    "self": { "href": "/goes_to_myself"},
+    "customers": [
+      { "href": "/customer/1"},
+	  { "href": "/customer/2"}
+    ]
+  }
+}

data/spec/support/hal_representor_shared.rb

@@ -0,0 +1,206 @@
+shared_examples_for 'can create a representor from a hal document' do
+
+  let(:semantics_field) {deserializer.to_representor.properties}
+  let(:transitions_field) {deserializer.to_representor.transitions}
+  let(:embedded_field) {deserializer.to_representor.embedded }
+  context "empty document" do
+    let(:document) { {}.to_json }
+
+    it "returns a hash with no attributes, links or embedded resources" do
+      expect(deserializer.to_representor.properties).to be_empty
+      expect(deserializer.to_representor.transitions).to be_empty
+      expect(deserializer.to_representor.embedded).to be_empty
+    end
+  end
+
+  context 'Document with only properties' do
+    let(:original_hash) do
+      {
+        'title' => 'The Neverending Story',
+        'author' => 'Michael Ende',
+        'pages' => '396'
+      }
+    end
+    let(:document) { original_hash.to_json}
+
+    it 'return a representor with all the attributes of the document' do
+      expect(semantics_field).to eq(original_hash)
+    end
+
+  end
+
+  context 'Document with properties and links' do
+    let(:semantics) { { 'title' => 'The Neverending Story'}}
+    let(:transition_rel) { 'author'}
+    let(:transition_href) { '/mike'}
+    let(:document) do
+      {
+        'title' => 'The Neverending Story',
+        '_links' => {
+          'author' => {'href' => '/mike'}
+        }
+      }
+    end
+
+    it 'return a hash with all the attributes of the document' do
+      expect(semantics_field).to eq(semantics)
+    end
+    it 'Create a transition with the link' do
+      expect(transitions_field.first.rel).to eq(transition_rel)
+      expect(transitions_field.first.uri).to eq(transition_href)
+    end
+    it 'does not return any embedded resource' do
+      expect(embedded_field).to be_empty
+    end
+
+  end
+
+  context 'Document with properties, links and embedded' do
+    let(:semantics) { { 'title' => 'The Neverending Story'}}
+    let(:transition_rel) { 'author'}
+    let(:transition_href) { '/mike'}
+    let(:embedded_book) { {'content' => 'A...'} }
+    let(:document) do
+      {
+        'title' => 'The Neverending Story',
+        '_links' => {
+          transition_rel => {'href' => transition_href}
+        },
+        '_embedded' => {
+          'embedded_book' => embedded_book
+        }
+      }
+    end
+    it 'Returns a hash with all the attributes of the document' do
+      expect(semantics_field).to eq(semantics)
+    end
+    it 'Creates a transition with the link' do
+      expect(transitions_field.first.rel).to eq(transition_rel)
+      expect(transitions_field.first.uri).to eq(transition_href)
+    end
+
+    it 'Creates an embedded resource with its data' do
+      expect(embedded_field['embedded_book'].properties).to eq(embedded_book)
+    end
+  end
+
+
+  context 'Document with an embedded collection' do
+    let(:embedded_book1) { {'content' => 'A...'} }
+    let(:embedded_book2) { {'content' => 'When...'} }
+    let(:embedded_book3) { {'content' => 'Once upon...'} }
+    let(:embedded_books) { [ embedded_book1, embedded_book2, embedded_book3 ] }
+    let(:document) do
+      {
+        '_embedded' => {
+          'embedded_books' => [ embedded_book1, embedded_book2, embedded_book3 ]
+        }
+      }
+    end
+
+    it 'Creates three embedded resources' do
+      expect(embedded_field['embedded_books'].size).to eq(embedded_books.size)
+    end
+
+    it 'Creates embedded resources with its data' do
+      embedded_books.each_with_index do |item, index|
+        expect(embedded_field['embedded_books'][index].properties).to eq(item)
+      end
+    end
+  end
+
+  context 'Document with only a self link and a title' do
+    let(:href) { '/example_resource'}
+    let(:title) { 'super!'}
+    let(:document) do
+      { '_links' => {
+        'self' => { 'href' => href, 'title' => title}
+        }
+      }
+    end
+
+    it 'the transition has a "self" rel' do
+      expect(transitions_field.first.rel).to eq('self')
+    end
+
+    it 'The transition has its href set properly' do
+      expect(transitions_field.first.uri).to eq(href)
+    end
+
+    it 'The transition has a title' do
+      expect(transitions_field.first['title']).to eq(title)
+    end
+
+  end
+
+  context 'Document with an array of two links under items' do
+    let(:first_href) {'/example_resource'}
+    let(:second_href) {'/lotr_resource2'}
+    let(:rel) { 'items'}
+    let(:document) do
+      { '_links' => {
+          rel => [{ 'href' => first_href, 'title' => 'resource1'},
+                     { 'href' => second_href, 'title' => 'resource2'}]
+        }
+      }
+    end
+
+    it 'The representor has two links' do
+      expect(transitions_field.size).to eq(2)
+    end
+
+    it 'The transitions have a rel properly set' do
+      expect(transitions_field.all?{|link| link.rel == 'items'}).to eq(true)
+    end
+
+    it 'The transitions have a href properly set ' do
+      expect(transitions_field[0].uri).to eq(first_href)
+      expect(transitions_field[1].uri).to eq(second_href)
+    end
+  end
+
+  context 'Document with a link without a href' do
+    let(:document) do
+      { '_links' => {
+        'self' => { 'title' => 'things'}
+        }
+      }
+    end
+
+    it 'raises a DeserializationError' do
+      expect{transitions_field}.to raise_error(Representors::DeserializationError, "All links must contain the href attribute")
+    end
+  end
+
+  context 'Document where not all links have href' do
+    let(:link_properties) { { 'href' => '/example_resource'} }
+    let(:document) do
+      { '_links' => {
+          'items' => [{ 'title' => 'resource1'},
+                     { 'href' => '/example_resource2', 'title' => 'resource2'}]
+        }
+      }
+    end
+
+    it 'raises a DeserializationError' do
+      expect{transitions_field}.to raise_error(Representors::DeserializationError, "All links must contain the href attribute")
+    end
+  end
+
+  context 'Document with CURIEs' do
+    let(:link_properties) { { 'href' => '/example_resource'} }
+    let(:document) do
+      { '_links' => {
+        'curies' => { 'href' => '/example_resource'}
+        }
+      }
+    end
+
+    it 'raises a DeserializationError' do
+      expect{transitions_field}.to raise_error(Representors::DeserializationError, "CURIE support not implemented for HAL")
+    end
+  end
+
+end
+
+

data/spec/support/helpers.rb

@@ -0,0 +1,8 @@
+module Support
+  module Helpers
+    # Add some helpers
+    def fixture_path(*args)
+      File.join(SPEC_DIR, 'fixtures', args)
+    end
+  end
+end

data/tasks/benchmark.rake

@@ -0,0 +1,75 @@
+require 'representors'
+require 'benchmark'
+
+ITERATIONS = 5
+DESERIALIZATIONS = 10_000
+HAL_BENCHMARK_FILE = 'complex_hal_document.json'
+HALE_BENCHMARK_FILE = 'complex_hale_document.json'
+
+
+def benchmark
+  benchmark_result = Benchmark.bm do |benchmarker|
+    1.upto(ITERATIONS) do |iteration|
+      benchmarker.report("Iteration #{iteration}") do
+        DESERIALIZATIONS.times do
+          yield
+        end
+      end
+    end
+  end
+  benchmark_result
+  average_total_times = benchmark_result.map(&:total).inject(&:+) / ITERATIONS
+  average_operation_ms = (average_total_times * 1000) / DESERIALIZATIONS
+
+  puts "Processing #{DESERIALIZATIONS} objects took on average #{'%.4f' % average_total_times} seconds"
+  puts "It took #{'%.4f' % average_operation_ms} milliseconds to process each document or representor"
+end
+
+def benchmark_deserializer(format, document)
+  data = File.read( File.join(File.dirname(__FILE__), document))
+  puts "Deserializing #{format}:"
+
+  benchmark do
+    result = Representors::DeserializerFactory.build(format, data).to_representor
+    result.properties
+    result.transitions
+    result.embedded
+  end
+  puts "------------------"
+  puts " "
+end
+
+
+def benchmark_serializer(format, document)
+  data = File.read( File.join(File.dirname(__FILE__), document))
+  representor = Representors::DeserializerFactory.build(format, data).to_representor
+
+  puts "Serializing #{format}:"
+
+  benchmark do
+    Representors::SerializerFactory.build(format, representor).to_media_type
+  end
+  puts "------------------"
+  puts " "
+end
+
+namespace :benchmark do
+  desc 'Benchmark deserializations'
+  task :deserializations do
+    benchmark_deserializer('application/hal+json', HAL_BENCHMARK_FILE )
+    benchmark_deserializer('application/vnd.hale+json', HALE_BENCHMARK_FILE )
+  end
+
+  desc 'Benchmark serializations'
+  task :serializations do
+    benchmark_serializer('application/hal+json', HAL_BENCHMARK_FILE )
+    benchmark_serializer('application/vnd.hale+json', HALE_BENCHMARK_FILE )
+  end
+
+  desc 'runs all benchmarks'
+  task :all do
+    Rake::Task['benchmark:deserializations'].invoke
+    Rake::Task['benchmark:serializations'].invoke
+  end
+
+end

data/tasks/complex_hal_document.json

@@ -0,0 +1,98 @@
+{
+  "_links":{
+     "self":{
+        "href":"http://example.org/api/user/ed"
+     },
+     "testrel":{
+        "href":"http://example.org/api/user/test",
+        "templated":true,
+        "type":"some-type",
+        "deprecation":"http://very-deprecated.com",
+        "name":"some-name",
+        "profile":"some-profile",
+        "title":"A Great Title",
+        "hreflang":"en-US"
+     },
+     "testrelarray":[
+        {
+           "href":"http://example.org/api/user/test1",
+           "templated":true,
+           "type":"some-type",
+           "deprecation":"http://very-deprecated.com",
+           "name":"some-name",
+           "profile":"some-profile",
+           "title":"A Great Title",
+           "hreflang":"en-US"
+        },
+        {
+           "href":"http://example.org/api/user/test2",
+           "templated":true,
+           "type":"some-type",
+           "deprecation":"http://very-deprecated.com",
+           "name":"some-name",
+           "profile":"some-profile",
+           "title":"A Great Title",
+           "hreflang":"en-US"
+        }
+     ]
+  },
+  "some-property":123,
+  "_embedded":{
+     "embedded1":{
+        "_links":{
+           "self":{
+              "href":"http:/nice.com"
+           },
+           "testrel":{
+              "href":"http://example.org/api/user/test",
+              "templated":true,
+              "type":"some-type",
+              "deprecation":"http://very-deprecated.com",
+              "name":"some-name",
+              "profile":"some-profile",
+              "title":"A Great Title",
+              "hreflang":"en-US"
+           }
+        },
+        "some-property":1234
+     },
+     "embeddedarray":[
+        {
+           "_links":{
+              "self":{
+                 "href":"http:/nice.com"
+              },
+              "testrel":{
+                 "href":"http://example.org/api/user/test",
+                 "templated":true,
+                 "type":"some-type",
+                 "deprecation":"http://very-deprecated.com",
+                 "name":"some-name",
+                 "profile":"some-profile",
+                 "title":"A Great Title",
+                 "hreflang":"en-US"
+              }
+           },
+           "some-property":1234
+        },
+        {
+           "_links":{
+              "self":{
+                 "href":"http:/nice.com"
+              },
+              "testrel":{
+                 "href":"http://example.org/api/user/test",
+                 "templated":true,
+                 "type":"some-type",
+                 "deprecation":"http://very-deprecated.com",
+                 "name":"some-name",
+                 "profile":"some-profile",
+                 "title":"A Great Title",
+                 "hreflang":"en-US"
+              }
+           },
+           "some-property":1234
+        }
+     ]
+  }
+}

data/tasks/test_specs.rake

@@ -0,0 +1,37 @@
+require 'open-uri'
+require 'json'
+
+
+def convert_to_representor(index, example)
+  representor = Representors::HaleDeserializer.new(example).to_representor
+  serialized_representor = Representors::Serialization::HaleSerializer.new(representor).to_media_type
+  if JSON.parse(serialized_representor) != JSON.parse(example)
+    puts example
+    puts "Example number #{index} can not be roundtriped!"
+  else
+    puts "Example number #{index} was roundtriped, HOORAY!"
+  end
+
+rescue JSON::ParserError
+  puts example
+  puts "Example number #{index} has a JSON error!"
+rescue TypeError => e
+  puts example
+  puts "Example number #{index} breaks our code!"
+  puts e
+end
+
+#TODO: Test Hal spec also
+desc "Rake tast to test the implementation against the specs"
+task :test_specs do
+
+  hale_spec = ''
+  hale_spec << open('https://raw.githubusercontent.com/mdsol/hale/master/README.md').read
+
+  examples = hale_spec.scan(/```json(.*?)```/m).flatten
+
+  examples.each_with_index do |example, index|
+    convert_to_representor(index+1, example)
+  end
+
+end