halibut 0.3.1 → 0.4.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NTE5OTFlZmM2MWFlYmVmNTgyZDE5ZDBjYTlkMTY3ZjZkNGZkZjI1Zg==
+  data.tar.gz: !binary |-
+    NTc2NDIzNWUwMzhhZjMwYzkyNjg1NTFlMzYxZTg2M2JmOTZiZDE4OA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    OGYxZTU0OTljZGJjMjdiYTM2MjU3YWVjYTRhMWVmZWI1ZDljZjc4NTIwYWI2
+    ZGZmMTg4NzJmNjRjMmQyYTdhNGM0MTlmNjRhNTc1NDg0NmQxYzJkZGEzZTVk
+    YTJiOTcwMjFjYWRlNDVmNzU5OTcyMWQ2MDE1ZDBjMzExOTA5M2U=
+  data.tar.gz: !binary |-
+    MDMzZjk4NGI5MmE2MjZlYjdmOWI4MDA4MjExM2JiNzJhYjdkZDE3NmQ1MWU4
+    MTM0NWNkZTFjNmZhYTdmNzYzNTM4NjVjMzFlMWZjODk3YzcxYTcyN2I2MTc5
+    MzU4ZGE4Y2NkYTAyNTVjMTNlZDU1MDkwZTM0YmM2ZDUyMDQwZTA=

data/.travis.yml

@@ -1,10 +1,9 @@
 language: ruby
 bundler_args: --without testing
 rvm:
-  - 1.9.2
   - 1.9.3
+  - 2.0.0
   - ruby-head
   - jruby-19mode
   - jruby-head
-  - rbx-19mode
-
+  - rbx-2.1.1

data/Gemfile

@@ -1,20 +1,15 @@
-source :rubygems
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in halibut.gemspec
 gemspec
 
 group :travis do
   gem "rake"
+  gem "coveralls"
 end
 
 group :testing do
-  gem "guard"
-
   gem "pry", ">= 0.9.10"
-  gem "pry-doc"
-  gem "pry-stack_explorer"
-  gem "pry-coolline", "0.1.5"
-  gem "pry-rescue", "0.13"
 
   gem "guard"
   gem "guard-bundler"
@@ -22,4 +17,14 @@ group :testing do
 
   gem "rb-fsevent"
   gem "terminal-notifier-guard"
-end
+end
+
+group :script do
+  gem "rest-client"
+end
+
+platforms 'rbx' do
+  gem 'rubysl'
+  gem 'rubinius-coverage'
+  gem 'rubysl-test-unit'
+end

data/README.md

@@ -1,8 +1,11 @@
-# Halibut [![endorse](http://api.coderwall.com/locks/endorsecount.png)](http://coderwall.com/locks)
+# Halibut [![endorse](http://api.coderwall.com/locks/endorsecount.png)](http://coderwall.com/locks) [![Stories in Ready](http://badge.waffle.io/locks/halibut.png)](http://waffle.io/locks/halibut)  
 
-[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/locks/halibut)
-[![Build Status](https://secure.travis-ci.org/locks/halibut.png?branch=master)](https://travis-ci.org/locks/halibut)
+
+[![Gem Version](https://badge.fury.io/rb/halibut.png)](http://badge.fury.io/rb/halibut)
+[![Build Status](https://secure.travis-ci.org/locks/halibut.png?branch=master)](https://travis-ci.org/locks/halibut)
+[![Coverage Status](https://coveralls.io/repos/locks/halibut/badge.png?branch=master)](https://coveralls.io/r/locks/halibut)
 [![Dependency Status](https://gemnasium.com/locks/halibut.png)](https://gemnasium.com/locks/halibut)
+[![Code Climate](https://codeclimate.com/github/locks/halibut.png)](https://codeclimate.com/github/locks/halibut)
 
 Halibut is a tiny gem that makes it easier to deal with the [HAL](http://stateless.co/hal_specification.html) format.
 
@@ -37,12 +40,12 @@ There are three ways to get a resource with halibut: manual, Builder, and JSON.
 require 'halibut'
 
 # manually creating a resource
-order = Halibut::HAL::Resource.new "/orders/123"
+order = Halibut::Core::Resource.new "/orders/123"
 order.set_property "total", 30.00
 order.set_property "currency", "USD"
 order.set_property "status", "shipped"
 
-resource = Halibut::HAL::Resource.new "/orders"
+resource = Halibut::Core::Resource.new "/orders"
 resource.add_link "find", "/orders{?id}", templated: true
 resource.add_link "next", "/orders/1", "name" => 'hotdog'
 resource.add_link "next", "/orders/9"
@@ -104,17 +107,6 @@ Halibut::Adapter::JSON.dump resource
 resource = Halibut::Adapter::JSON.load 'resource.json'
 ```
 
-### XML
-```ruby
-require 'halibut/adapter/xml'
-
-# converting to XML
-# Coming soon…
-
-# creating a resource from XML
-resource = Halibut::Adapter::XML.load 'resource.xml'
-```
-
 ## Contributing
 
 1. Fork it

data/halibut.gemspec

@@ -15,13 +15,13 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = Halibut::VERSION
 
-  gem.required_ruby_version = '~> 1.9.3'
+  gem.required_ruby_version = '>= 1.9.3'
 
   gem.add_dependency "multi_json"
-  gem.add_dependency "nokogiri"
   gem.add_dependency "addressable"
 
   # this version of minitest adds parallelization
+  gem.add_development_dependency "rake"
   gem.add_development_dependency "minitest", ">= 4.2"
   gem.add_development_dependency "hash-differ"
 

data/lib/halibut.rb

@@ -2,19 +2,17 @@ require "halibut/version"
 
 # Halibut is the main namespace
 module Halibut
-  autoload :Builder,     'halibut/builder'
-  autoload :RelationMap, 'halibut/relation_map'
+  autoload :Builder,  'halibut/builder'
+  autoload :Document, 'halibut/document'
 end
 
 # The Adapter namespace contains classes that aid in the
 # mapping of HAL Resources into a specific format.
 module Halibut::Adapter
   autoload :JSON, 'halibut/adapter/json'
-  autoload :XML,  'halibut/adapter/xml'
 end
 
-# Halibut::HAL contains the domain objects that reflect the HAL specs.
-module Halibut::HAL
-  autoload :Link,     'halibut/hal/link'
-  autoload :Resource, 'halibut/hal/resource'
+# Halibut::Core contains the domain objects that reflect the HAL specs.
+module Halibut::Core
+  autoload :Resource, 'halibut/core/resource'
 end

data/lib/halibut/adapter/json.rb

@@ -1,5 +1,7 @@
 require 'multi_json'
 
+require 'halibut/core'
+
 module Halibut::Adapter
 
   module JSON
@@ -24,16 +26,12 @@ module Halibut::Adapter
 
     class ResourceExtractor
       def initialize(json)
-        @halibut = Halibut::HAL::Resource.new
-        json     = MultiJson.load(json)
-
-        links      = json.delete '_links'
-        resources  = json.delete '_embedded'
-        properties = json
+        @halibut = Halibut::Core::Resource.new
+        @json    = MultiJson.load(json)
 
-        properties and extract_properties properties
-        links      and extract_links      links
-        resources  and extract_resources  resources
+        extract_properties
+        extract_links
+        extract_embedded_resources
       end
 
       def resource
@@ -41,24 +39,31 @@ module Halibut::Adapter
       end
 
       private
-      def extract_properties(properties)
+      def extract_properties
+        properties = @json.reject {|k,v| k == '_links'    }
+                          .reject {|k,v| k == '_embedded' }
+
         properties.each_pair do |property, value|
           @halibut.set_property(property, value)
         end
       end
 
-      def extract_links(links)
+      def extract_links
+        links = @json.fetch('_links', [])
+
         links.each do |relation,values|
-          links = ([] << values).flatten
+          link = ([] << values).flatten
 
-          links.each do |attrs|
+          link.each do |attrs|
             href      = attrs.delete 'href'
             @halibut.add_link(relation, href, attrs)
           end
         end
       end
 
-      def extract_resources(resources)
+      def extract_embedded_resources
+        resources = @json.fetch('_embedded', [])
+
         resources.each do |relation,values|
           embeds = ([] << values).flatten
 
@@ -69,4 +74,4 @@ module Halibut::Adapter
       end
     end
   end
-end
+end

data/lib/halibut/builder.rb

@@ -1,41 +1,32 @@
-require 'halibut/hal/resource'
+require 'halibut/core/resource'
 
 module Halibut
 
   # Builder provides a very thin wrapper around creating a HAL resource.
   class Builder
 
-    # The HAL resource built
-    attr_reader :resource
-
     #
     #
     # @param [String] href
     # @param [Proc]   blk
     def initialize(href=nil, &blk)
-      @resource = Halibut::HAL::Resource.new href
+      @resource = Halibut::Core::Resource.new href
 
       RootContext.new(@resource, &blk)
     end
 
-    def respond_to?(meth, *args)
-      RootContext.new(@resource).respond_to? meth
-    end
-
-    def method_missing meth, *args
-      RootContext.new(@resource).send meth, *args
+    # Returns the resource built.
+    #
+    # @return [Halibut::Core::Resource] resource built with the DSL
+    def resource
+      @resource
     end
 
     private
-
     # This is the root context of Halibut::Builder.
     #
     #
     class RootContext
-      extend Forwardable
-
-      def_delegator :@resource, :set_property, :property
-      def_delegator :@resource, :add_link,     :link
 
       def initialize(resource, &blk)
         @resource = resource
@@ -43,6 +34,26 @@ module Halibut
         instance_eval(&blk) if block_given?
       end
 
+      # Sets a property on the resource.
+      # Will overwrite any same-named existing property.
+      #
+      # @param [String] name  name of the property
+      # @param [String] value value of the property
+      # @return [Halibut::Core::resource] resource with property set
+      def property(name, value)
+        @resource.set_property name, value
+      end
+
+      # Adds a link to the respection relation of the resource.
+      #
+      # @param [String] relation relation to which link will be added
+      # @param [String] href     URI of the link
+      # @param [Hash]   options  Link optional parameters: templated, hreflang, etc
+      # @return [Halibut::Core::Resource] resource with the link added
+      def link(relation, href, options={})
+        @resource.add_link relation, href, options
+      end
+
       # Adds a namespace to the resource.
       #
       # A namespace is a conceptual abstraction of CURIE links.
@@ -62,6 +73,11 @@ module Halibut
         @resource.add_namespace(name, href)
       end
 
+      # Adds an embedded resource.
+      #
+      # @param [String] rel  Embedded resource relation to the parent resource
+      # @param [String] href URI to the resource itself
+      # @param [Proc]   blk  Instructions to construct the embedded resource
       def resource(rel, href=nil, &blk)
         embedded = Halibut::Builder.new(href, &blk)
 
@@ -88,7 +104,6 @@ module Halibut
       def relation(rel, &blk)
         RelationContext.new(@resource, rel, &blk)
       end
-
     end
 
     class RelationContext
@@ -101,7 +116,7 @@ module Halibut
       end
 
       def link(href, opts={})
-        @resource.add_link(@rel, href, opts)
+        @resource.tap {|obj| obj.add_link(@rel, href, opts) }
       end
 
       def resource(href=nil, &blk)
@@ -112,5 +127,4 @@ module Halibut
     end
 
   end
-
-end
+end

data/lib/halibut/core.rb

@@ -0,0 +1,6 @@
+module Halibut
+  module Core
+    autoload :Resource, 'halibut/core/resource'
+    autoload :Link,     'halibut/core/link'
+  end
+end

data/lib/halibut/{hal → core}/link.rb

@@ -1,4 +1,4 @@
-module Halibut::HAL
+module Halibut::Core
   # This class represents a HAL Link object.
   #
   # spec spec spec.
@@ -27,7 +27,7 @@ module Halibut::HAL
     # @param [String]  href      URI or URI Template
     # @param [Hash]    opts      Options: type, name, profile, title, hreflang
     #
-    # @return [Halibut::HAL::Link] HAL Link object
+    # @return [Halibut::Core::Link] HAL Link object
     def initialize(href, opts={})
       @href    = href
       @options = Options.new opts
@@ -64,7 +64,7 @@ module Halibut::HAL
 
     private
     # Options reifies the various optional properties of a link, as per the
-    # spec.
+    # spec: templated, type, name, profile, title, hreflang.
     #
     #     hash = { name: 'John le Carré', templated: true }
     #     opts = Options.new(hash)
@@ -77,6 +77,8 @@ module Halibut::HAL
                   :profile, :title, :hreflang
 
       def initialize opts
+        string_options = Helpers::stringify_keys(opts)
+
         @templated = opts[:templated] || opts['templated']
         @type      = opts[:type]      || opts['type']
         @name      = opts[:name]      || opts['name']
@@ -124,6 +126,13 @@ module Halibut::HAL
       def ==(other)
         to_hash == other.to_hash
       end
+
+      private
+      module Helpers
+        def self.stringify_keys(hash)
+          hash.each_with_object({}) {|(k,v), obj| obj[k.to_s] = v }
+        end
+      end
     end
   end
 

data/lib/halibut/{relation_map.rb → core/relation_map.rb}

@@ -1,4 +1,4 @@
-module Halibut
+module Halibut::Core
 
   # This is an abstract map with behaviour specific to HAL.
   #
@@ -17,15 +17,15 @@ module Halibut
     #     relations = RelationMap.new
     #     relations.add 'self', Link.new('/resource/1')
     #     relations['self']
-    #     # => [#<Halibut::HAL::Link:0x007fa0ca5b92b8 @href=\"/resource/1\",
-    #          @options=#<Halibut::HAL::Link::Options:0x007fa0ca5b9240
+    #     # => [#<Halibut::Core::Link:0x007fa0ca5b92b8 @href=\"/resource/1\",
+    #          @options=#<Halibut::Core::Link::Options:0x007fa0ca5b9240
     #          @templated=nil, @type=nil, @name=nil, @profile=nil,
     #          @title=nil, @hreflang=nil>>]
     #
     # @param [String] relation relation that the object belongs to
     # @param [Object] item     the object to add to the relation
     def add(relation, item)
-      @relations[relation] = @relations[relation].to_a << item
+      @relations[relation] = @relations.fetch(relation, []) << item
     end
 
     # Returns a hash corresponding to the object.
@@ -35,14 +35,12 @@ module Halibut
     #
     # @return [Hash] relation map in hash format
     def to_hash
-      @relations.each_with_object({}) do |pair, obj|
-        key, *value = pair.flatten
+      @relations.each_with_object({}) do |(rel,val), obj|
+        rel = rel.to_s
+        val = val.length == 1 ? val.first.to_hash : val.map(&:to_hash)
 
-        key = key.to_s
-
-        obj[key] = value.map &:to_hash
-        obj[key].length == 1 and obj[key] = obj[key].first
+        obj[rel] = val
       end
     end
   end
-end
+end

data/lib/halibut/{hal → core}/resource.rb

@@ -1,4 +1,6 @@
-module Halibut::HAL
+require 'halibut/core/relation_map'
+
+module Halibut::Core
 
   # This class represents a HAL Resource object.
   #
@@ -26,18 +28,18 @@ module Halibut::HAL
     # like suggested in https://github.com/locks/halibut/issues/1.
     #
     #     # Resource without self link (e.g. POSTing a new resource)
-    #     resource = Halibut::HAL::Resource.new
+    #     resource = Halibut::Core::Resource.new
     #     resource.set_property :name,   'Halibut Rules'
     #     resource.set_property :winner, 'Tiger Blood'
     #
     #     # Resource with a self link
-    #     resource = Halibut::HAL::Resource.new
+    #     resource = Halibut::Core::Resource.new
     #
     # @param [String] href Link that will be added to the self relation.
     def initialize(href=nil, properties={}, links={}, embedded={})
-      @namespaces = Halibut::RelationMap.new
-      @links      = Halibut::RelationMap.new
-      @embedded   = Halibut::RelationMap.new
+      @namespaces = RelationMap.new
+      @links      = RelationMap.new
+      @embedded   = RelationMap.new
       @properties = {}
 
       add_link('self', href) if href
@@ -61,7 +63,7 @@ module Halibut::HAL
 
     # Sets a property in the resource.
     #
-    #     resource = Halibut::HAL::Resource.new
+    #     resource = Halibut::Core::Resource.new
     #     resource.set_property :name, 'FooBar'
     #     resource.property :name
     #     # => "FooBar"
@@ -69,12 +71,20 @@ module Halibut::HAL
     # @param [Object] property the key
     # @param [Object] value    the value
     def set_property(property, value)
-      @properties[property] = value
+      if property == '_links' || property == '_embedded'
+        raise ArgumentError, "Argument #{property} is a reserved property"
+      end
+
+      tap { @properties[property] = value }
+    end
+
+    def []=(property, value)
+      tap { @properties[property] = value }
     end
 
     # Returns the value of a property in the resource
     #
-    #     resource = Halibut::HAL::Resource.new
+    #     resource = Halibut::Core::Resource.new
     #     resource.set_property :name, 'FooBar'
     #     resource.property :name
     #     # => "FooBar"
@@ -89,12 +99,12 @@ module Halibut::HAL
     # @param [String] name The name of the namespace
     # @param [String] href The templated URI of the namespace
     def add_namespace(name, href)
-      @links.add 'curie', Link.new(href, templated: true, name: name)
+      add_link 'curie', href, templated: true, name: name
     end
 
     # Adds link to relation.
     #
-    #     resource = Halibut::HAL::Resource.new
+    #     resource = Halibut::Core::Resource.new
     #     resource.add_link 'next', '/resource/2', name: 'Foo'
     #     link = resource.links['next'].first
     #     link.href
@@ -131,7 +141,7 @@ module Halibut::HAL
 
     # Compares two resources.
     #
-    # @param  [Halibut::HAL::Resource] other Resource to compare to
+    # @param  [Halibut::Core::Resource] other Resource to compare to
     # @return [true, false]                  Result of the comparison
     def ==(other)
       @properties == other.properties &&

data/lib/halibut/version.rb

@@ -1,4 +1,4 @@
 module Halibut
   # Semver version (I'll try, pinkie promise)
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

data/spec/adapter/json_spec.rb

@@ -9,7 +9,7 @@ read_files = ->() {
 describe Halibut::Adapter::JSON do
 
   it "serializes to JSON" do
-    resource = Halibut::HAL::Resource.new("http://example.com")
+    resource = Halibut::Core::Resource.new("http://example.com")
     subject  = Halibut::Adapter::JSON.dump resource
     json     = load_json "simple"
 
@@ -19,12 +19,12 @@ describe Halibut::Adapter::JSON do
   it "deserializes from JSON" do
     subject = Halibut::Adapter::JSON.load(load_json "serialize")
 
-    order = Halibut::HAL::Resource.new "/orders/123"
+    order = Halibut::Core::Resource.new "/orders/123"
     order.set_property "total", 30.00
     order.set_property "currency", "USD"
     order.set_property "status", "shipped"
 
-    resource = Halibut::HAL::Resource.new "/orders"
+    resource = Halibut::Core::Resource.new "/orders"
     resource.add_link "find", "/orders{?id}", templated: true
     resource.add_link "next", "/orders/1", "name" => 'hotdog'
     resource.add_link "next", "/orders/9"
@@ -39,12 +39,12 @@ describe Halibut::Adapter::JSON do
     json = Halibut::Adapter::JSON.load(load_json "serialize")
     json = Halibut::Adapter::JSON.dump(json)
 
-    order = Halibut::HAL::Resource.new "/orders/123"
+    order = Halibut::Core::Resource.new "/orders/123"
     order.set_property "total", 30.00
     order.set_property "currency", "USD"
     order.set_property "status", "shipped"
 
-    resource = Halibut::HAL::Resource.new "/orders"
+    resource = Halibut::Core::Resource.new "/orders"
     resource.add_link "find", "/orders{?id}", templated: true
     resource.add_link "next", "/orders/1", "name" => 'hotdog'
     resource.add_link "next", "/orders/9"
@@ -69,4 +69,4 @@ describe Halibut::Adapter::JSON do
     end
   end
 
-end
+end

data/spec/builder_spec.rb

@@ -7,14 +7,14 @@ describe Halibut::Builder do
   describe "Empty resource" do
     it "builds empty resource with no self link" do
       builder  = Halibut::Builder.new
-      resource = Halibut::HAL::Resource.new
+      resource = Halibut::Core::Resource.new
 
       builder.resource.must_equal resource
     end
 
     it "builds empty resource with self link" do
       builder  = Halibut::Builder.new 'default'
-      resource = Halibut::HAL::Resource.new 'default'
+      resource = Halibut::Core::Resource.new 'default'
 
       builder.resource.must_equal resource
     end
@@ -26,7 +26,7 @@ describe Halibut::Builder do
         property 'foo', 'bar'
       end
 
-      resource = Halibut::HAL::Resource.new
+      resource = Halibut::Core::Resource.new
       resource.set_property 'foo', 'bar'
 
       builder.resource.properties['foo'].must_equal 'bar'
@@ -40,7 +40,7 @@ describe Halibut::Builder do
         property 'medals', { gold: 1, silver: 5, bronze: 10 }
       end
 
-      resource = Halibut::HAL::Resource.new
+      resource = Halibut::Core::Resource.new
       resource.set_property 'foo', 'bar'
       resource.set_property 'baz', 'quux'
       resource.set_property 'medals', { gold: 1, silver: 5, bronze: 10 }
@@ -61,7 +61,7 @@ describe Halibut::Builder do
         link 'cs:search', '/search{?broms,noms}', templated: true
       end
 
-      resource = Halibut::HAL::Resource.new
+      resource = Halibut::Core::Resource.new
       resource.add_link 'cs:broms', '/broms/1'
       resource.add_link 'cs:search', '/search{?broms,noms}', templated: true
 
@@ -75,7 +75,7 @@ describe Halibut::Builder do
         link 'cs:search', '/search{?broms,noms}', templated: true
       end
 
-      resource = Halibut::HAL::Resource.new
+      resource = Halibut::Core::Resource.new
       resource.add_link 'cs:broms', '/broms/1'
       resource.add_link 'cs:broms', '/broms/2'
       resource.add_link 'cs:search', '/search{?broms,noms}', templated: true
@@ -93,11 +93,11 @@ describe Halibut::Builder do
         end
       end
 
-      game = Halibut::HAL::Resource.new '/game/1'
+      game = Halibut::Core::Resource.new '/game/1'
       game.set_property(:name, 'Crash Bandicoot')
       game.set_property(:console, 'PlayStation')
 
-      resource = Halibut::HAL::Resource.new
+      resource = Halibut::Core::Resource.new
       resource.embed_resource('games', game)
 
       builder.resource.must_equal resource, diff(builder.resource.to_hash, resource.to_hash)
@@ -115,15 +115,15 @@ describe Halibut::Builder do
         end
       end
 
-      game1 = Halibut::HAL::Resource.new '/game/1'
+      game1 = Halibut::Core::Resource.new '/game/1'
       game1.set_property(:name, 'Crash Bandicoot')
       game1.set_property(:console, 'PlayStation')
 
-      game2 = Halibut::HAL::Resource.new '/game/2'
+      game2 = Halibut::Core::Resource.new '/game/2'
       game2.set_property(:name, 'Super Mario Land')
       game2.set_property(:console, 'Game Boy')
 
-      resource = Halibut::HAL::Resource.new
+      resource = Halibut::Core::Resource.new
       resource.embed_resource('games', game1)
       resource.embed_resource('games', game2)
 
@@ -148,11 +148,11 @@ describe Halibut::Builder do
         end
       end
 
-      user = Halibut::HAL::Resource.new '/users/1'
+      user = Halibut::Core::Resource.new '/users/1'
       user.set_property :name, "foo"
       user.set_property :nick, "bar"
 
-      resource = Halibut::HAL::Resource.new
+      resource = Halibut::Core::Resource.new
       resource.add_link 'games', '/games/1'
       resource.add_link 'games', '/games/2'
       resource.add_link 'games', '/games/3'
@@ -164,20 +164,16 @@ describe Halibut::Builder do
   end
 
   describe "Namespace helper" do
-    let(:name) { 'cs' }
-    let(:href) { 'http://cs-api.herokuapp.com/rels/{rel}' }
+    let(:namespace) { 'cs' }
+    let(:href)      { 'http://cs-api.herokuapp.com/rels/{rel}' }
 
     it "builds resource using curie DSL" do
       builder = Halibut::Builder.new do
         namespace 'cs', 'http://cs-api.herokuapp.com/rels/{rel}'
       end
 
-      builder = Halibut::Builder.new
-      builder.namespace 'cs', 'http://cs-api.herokuapp.com/rels/{rel}'
-
       curie = builder.resource.links['curie'].first
-
-      curie.name.must_equal name
+      curie.name.must_equal namespace
       curie.href.must_equal href
     end
   end

data/spec/{link_spec.rb → core/link_spec.rb}

@@ -1,19 +1,21 @@
-require_relative 'spec_helper'
+require_relative '../spec_helper'
 
-describe Halibut::HAL::Link do
+require 'halibut/core/link'
+
+describe Halibut::Core::Link do
   let(:normal_uri) { 'http://example.com'      }
   let(:tmpl_uri)   { 'http://example.com/{id}' }
 
   describe "href" do
     it "accepts non-templated uri" do
-      link = Halibut::HAL::Link.new normal_uri
+      link = Halibut::Core::Link.new normal_uri
 
       link.templated?.must_equal false
       link.href.must_equal normal_uri
     end
 
     it "accepts templated uri" do
-      link = Halibut::HAL::Link.new tmpl_uri, templated: true
+      link = Halibut::Core::Link.new tmpl_uri, templated: true
 
       link.templated?.must_equal true
       link.href.must_equal tmpl_uri
@@ -22,14 +24,14 @@ describe Halibut::HAL::Link do
 
   describe "optionals" do
     it "are set correctly" do
-      link1 = Halibut::HAL::Link.new normal_uri, {
+      link1 = Halibut::Core::Link.new normal_uri, {
         :type     => 'type',
         :name     => 'name',
         :profile  => 'profile',
         :title    => 'title',
         :hreflang => 'hreflang'
       }
-      link2 = Halibut::HAL::Link.new normal_uri, {
+      link2 = Halibut::Core::Link.new normal_uri, {
         :type     => 'type',
         :name     => 'name',
         :profile  => 'profile',

data/spec/{relation_map_spec.rb → core/relation_map_spec.rb}

@@ -1,7 +1,9 @@
-require_relative 'spec_helper'
+require_relative '../spec_helper'
 
-describe Halibut::RelationMap do
-  subject { Halibut::RelationMap.new }
+require 'halibut/core/relation_map'
+
+describe Halibut::Core::RelationMap do
+  subject { Halibut::Core::RelationMap.new }
 
   it "is empty" do
     subject.must_be_empty

data/spec/{resource_spec.rb → core/resource_spec.rb}

@@ -1,7 +1,9 @@
-require_relative 'spec_helper'
+require_relative '../spec_helper'
 
-describe Halibut::HAL::Resource do
-  subject { Halibut::HAL::Resource.new }
+require 'halibut/core/resource'
+
+describe Halibut::Core::Resource do
+  subject { Halibut::Core::Resource.new }
   let(:templated_uri) { "http://example.com/{path}{?query}" }
   let(:normal_uri)    { "http://example.com" }
 
@@ -12,6 +14,11 @@ describe Halibut::HAL::Resource do
       subject.properties['property'].must_equal "value"
     end
 
+    it "fails to set reserved property" do
+      -> { subject.set_property "_links", "lol" }.must_raise ArgumentError
+      -> { subject.set_property "_embedded", "lol" }.must_raise ArgumentError
+    end
+
     it "read property" do
       subject.set_property "property", "value"
 
@@ -28,7 +35,7 @@ describe Halibut::HAL::Resource do
       end
 
       it "default" do
-        resource = Halibut::HAL::Resource.new normal_uri
+        resource = Halibut::Core::Resource.new normal_uri
 
         resource.links.wont_be_empty
         resource.links['self'].first.href.must_equal normal_uri
@@ -76,9 +83,9 @@ describe Halibut::HAL::Resource do
   end
 
   describe "Embedded resources" do
-    subject    { Halibut::HAL::Resource.new }
-    let(:res1) { Halibut::HAL::Resource.new "http://first-resource.com" }
-    let(:res2) { Halibut::HAL::Resource.new "http://secnd-resource.com" }
+    subject    { Halibut::Core::Resource.new }
+    let(:res1) { Halibut::Core::Resource.new "http://first-resource.com" }
+    let(:res2) { Halibut::Core::Resource.new "http://secnd-resource.com" }
 
     it "no embedded resource" do
       subject.embedded.must_be_empty

data/spec/spec_helper.rb

@@ -1,10 +1,13 @@
 require 'bundler/setup'
 
+require 'coveralls'
+Coveralls.wear!
+
 require 'minitest/autorun'
-require 'minitest/hell'
 
 require 'halibut'
 
+
 # Testing helper to load JSON files. Returns a string containing JSON.
 def load_json(filename)
   File.read(File.dirname(__FILE__)+"/fixtures/#{filename}.json")

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: halibut
 version: !ruby/object:Gem::Version
-  version: 0.3.1
-  prerelease: 
+  version: 0.4.0
 platform: ruby
 authors:
 - Ricardo Mendes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-14 00:00:00.000000000 Z
+date: 2013-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -22,15 +20,13 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: addressable
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -38,23 +34,20 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: addressable
+  name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -62,7 +55,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -70,7 +62,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -78,7 +69,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: hash-differ
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -86,7 +76,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -100,7 +89,6 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .gitmodules
-- .rvmrc
 - .travis.yml
 - Gemfile
 - Guardfile
@@ -111,62 +99,59 @@ files:
 - halibut.gemspec
 - lib/halibut.rb
 - lib/halibut/adapter/json.rb
-- lib/halibut/adapter/xml.rb
 - lib/halibut/builder.rb
-- lib/halibut/hal/link.rb
-- lib/halibut/hal/resource.rb
+- lib/halibut/core.rb
+- lib/halibut/core/link.rb
+- lib/halibut/core/relation_map.rb
+- lib/halibut/core/resource.rb
 - lib/halibut/link_relation.rb
-- lib/halibut/relation_map.rb
 - lib/halibut/version.rb
 - spec/adapter/json_spec.rb
-- spec/adapter/xml_spec.rb
 - spec/builder_spec.rb
+- spec/core/link_spec.rb
+- spec/core/relation_map_spec.rb
+- spec/core/resource_spec.rb
 - spec/fixtures/example.json
 - spec/fixtures/example.xml
 - spec/fixtures/minimal.json
 - spec/fixtures/serialize.json
 - spec/fixtures/simple.json
 - spec/link_relation_spec.rb
-- spec/link_spec.rb
-- spec/relation_map_spec.rb
-- spec/resource_spec.rb
 - spec/spec_helper.rb
 homepage: http://locks.github.com/halibut
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ~>
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A HAL parser and builder for use in Hypermedia APIs
 test_files:
 - spec/adapter/json_spec.rb
-- spec/adapter/xml_spec.rb
 - spec/builder_spec.rb
+- spec/core/link_spec.rb
+- spec/core/relation_map_spec.rb
+- spec/core/resource_spec.rb
 - spec/fixtures/example.json
 - spec/fixtures/example.xml
 - spec/fixtures/minimal.json
 - spec/fixtures/serialize.json
 - spec/fixtures/simple.json
 - spec/link_relation_spec.rb
-- spec/link_spec.rb
-- spec/relation_map_spec.rb
-- spec/resource_spec.rb
 - spec/spec_helper.rb
 has_rdoc: 

data/.rvmrc

@@ -1 +0,0 @@
-rvm use --create default@halibut

data/lib/halibut/adapter/xml.rb

@@ -1,86 +0,0 @@
-require 'nokogiri'
-
-module Halibut::Adapter
-
-  module XML
-    def self.load(xml)
-      ResourceExtractor.new(xml).resource
-    end
-
-    def self.dump(resource)
-      raise NotImplementedError
-    end
-
-    private
-    def self.extended(base)
-      base.extend InstanceMethods
-    end
-
-    module InstanceMethods
-      def to_xml
-        raise NotImplementedError
-      end
-    end
-
-    class ResourceExtractor
-
-      attr_reader :resource
-
-      def initialize(xml)
-        xml = Nokogiri::XML(xml)
-
-        @document = xml.root
-        @resource = Halibut::HAL::Resource.new extract_self_link
-
-        extract_curie
-        extract_properties
-        extract_links
-        extract_resources
-      end
-
-      private
-      def extract_self_link
-        @document.attr 'href'
-      end
-
-      def extract_curie
-        @document.namespace_scopes
-                 .reject {|ns| ns.prefix.eql? 'xsi' }
-                 .each do |ns|
-          @resource.add_link 'curie', ns.href, name: ns.prefix
-        end
-      end
-
-      def extract_properties
-        properties = @document.xpath '/resource/*[not(self::link) and not(self::resource)]'
-
-        properties.each do |property|
-          @resource.set_property property.name, property.content
-        end
-      end
-
-      def extract_links
-        links = @document.xpath('/resource/link')
-
-        links.each do |link|
-          @resource.add_link link['rel'],
-                             link['href'],
-                             extract_link_options(link)
-        end
-      end
-
-      # In case there are no options on the link, it returns an empty hash
-      def extract_link_options(link)
-        Hash[link.reject {|(key)| key.eql? 'rel'  }
-                 .reject {|(key)| key.eql? 'href' }]
-      end
-
-      def extract_resources
-        @document.xpath('/resource/resource')
-                 .map  {|r| [] << r['rel'] << ResourceExtractor.new(r.to_xml).resource }
-                 .each {|rel,res| @resource.embed_resource rel, res }
-      end
-    end
-  end
-
-end

data/spec/adapter/xml_spec.rb

@@ -1,49 +0,0 @@
-require_relative '../spec_helper'
-
-
-read_files = ->() {
-  Dir.tap {|it| it.chdir('spec/test-resources/src/main/resources') } \
-     .glob('*.xml') \
-     .map {|f| File.read f }
-}
-
-
-describe Halibut::Adapter::XML do
-
-  it "serializes to XML" do
-    skip "To Be Implemented"
-  end
-
-  it "deserializes from XML" do
-    builder = Halibut::Builder.new 'https://example.com/api/customer/123456' do
-      property 'age', "33"
-      property 'expired', "false"
-      property 'id', "123456"
-      property 'name', 'Example Resource'
-      property 'nullprop', ""
-      property 'optional', "true"
-
-      relation 'curie' do
-        link 'https://example.com/apidocs/accounts', name: 'ns'
-        link 'https://example.com/apidocs/roles',    name: 'role'
-      end
-      link 'ns:parent', 'https://example.com/api/customer/1234', name: 'bob',
-                                                                 title: 'The Parent',
-                                                                 hreflang: 'en'
-      link 'ns:users', 'https://example.com/api/customer/123456?users'
-    end.resource
-
-    xml = load_resource('exampleWithNullProperty.xml')
-
-    deserialized = Halibut::Adapter::XML.load(xml)
-    deserialized.must_equal builder, diff(deserialized.to_hash, builder.to_hash)
-  end
-
-  it "provides to_xml helper" do
-    skip "To Be Implemented"
-
-    xml = Halibut::Adapter::XML.load(load_resource 'exampleWithNullProperty.xml')
-    xml = Halibut::Adapter::XML.dump(xml)
-  end
-
-end