halibut 0.4.0 → 0.4.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NTE5OTFlZmM2MWFlYmVmNTgyZDE5ZDBjYTlkMTY3ZjZkNGZkZjI1Zg==
+    MWYxOTQ4OTZiYzU2ZWQyZjk1OTE3NzVmMTA3OTVkMzBhMTQ5NmIyYQ==
   data.tar.gz: !binary |-
-    NTc2NDIzNWUwMzhhZjMwYzkyNjg1NTFlMzYxZTg2M2JmOTZiZDE4OA==
-!binary "U0hBNTEy":
+    NDYzNzNhZjdkZWYxOTg1NjQzOWEzYWQwM2UzZTk0N2FmOWNhYTc1Zg==
+SHA512:
   metadata.gz: !binary |-
-    OGYxZTU0OTljZGJjMjdiYTM2MjU3YWVjYTRhMWVmZWI1ZDljZjc4NTIwYWI2
-    ZGZmMTg4NzJmNjRjMmQyYTdhNGM0MTlmNjRhNTc1NDg0NmQxYzJkZGEzZTVk
-    YTJiOTcwMjFjYWRlNDVmNzU5OTcyMWQ2MDE1ZDBjMzExOTA5M2U=
+    OTdjNmE0Mzg3MDlmZmJlMzc2ZGI1YzE3ZTc4OGZiMjdmNDc2ZDhhMzUwOTM4
+    ODA4NDhkNGQ1MjlkMjhjNzY3N2MyMzM4YWVmMjdiM2Q1YmY2NGM0MmM3OGYy
+    Y2U1NDNkMjNmOGNkYjBjYmUzYjQxNTI2ZGU2ZWM0MWU4Y2MzY2I=
   data.tar.gz: !binary |-
-    MDMzZjk4NGI5MmE2MjZlYjdmOWI4MDA4MjExM2JiNzJhYjdkZDE3NmQ1MWU4
-    MTM0NWNkZTFjNmZhYTdmNzYzNTM4NjVjMzFlMWZjODk3YzcxYTcyN2I2MTc5
-    MzU4ZGE4Y2NkYTAyNTVjMTNlZDU1MDkwZTM0YmM2ZDUyMDQwZTA=
+    ZDAxZTlhYjRjNzEyOTM4ODg3ZmJmYzczMGU1YTVhMDBlNmZmNzcwNWYyNzhk
+    NmU4MTJmNWVjYTQzNWE5OTEzMDUzYjNkYzcxODk5ZjM4ZjQ5YTNjMzQyYTZk
+    YzYwOGU2ZjMxOGIzMWJhZWFkZDY5YWVmMGM1NTYwZTk0NmE1OGE=

data/.travis.yml

@@ -1,9 +1,17 @@
 language: ruby
 bundler_args: --without testing
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - ruby-head
-  - jruby-19mode
-  - jruby-head
-  - rbx-2.1.1
+- 1.9.3
+- 2.0.0
+- ruby-head
+- jruby-19mode
+- jruby-head
+- rbx-2.1.1
+deploy:
+  provider: rubygems
+  api_key:
+    secure: cMM9SSWMkq6G10Sxs2CXDacurZOkJiaHPHgfffE/6SadZ2nYxPiR637VVq1CspT0rs5La9qUQD7ZwRQ046WfPw84rx5iu8J+sBf7bTrI0OcQLJHcbCGUaFpH01JVD6Nhch5ZrOcts3Xzm7hbOxgEHqATMbCgGb2q9vBORhatnj4=
+  gem: halibut
+  on:
+    tags: true
+    repo: locks/halibut

data/README.md

@@ -1,6 +1,5 @@
 # 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)  
 
-
 [![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)

data/halibut.gemspec

@@ -18,11 +18,9 @@ Gem::Specification.new do |gem|
   gem.required_ruby_version = '>= 1.9.3'
 
   gem.add_dependency "multi_json"
-  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"
-
 end

data/lib/halibut.rb

@@ -1,18 +1,17 @@
 require "halibut/version"
 
 # Halibut is the main namespace
-module Halibut
-  autoload :Builder,  'halibut/builder'
-  autoload :Document, 'halibut/document'
-end
+module Halibut; end
+
+require 'halibut/builder'
 
 # 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'
-end
+module Halibut::Adapter; end
+
+require 'halibut/adapter/json'
 
 # Halibut::Core contains the domain objects that reflect the HAL specs.
-module Halibut::Core
-  autoload :Resource, 'halibut/core/resource'
-end
+module Halibut::Core; end
+
+require 'halibut/core/resource'

data/lib/halibut/adapter/json.rb

@@ -1,30 +1,67 @@
 require 'multi_json'
-
 require 'halibut/core'
 
 module Halibut::Adapter
 
+  # This adapter converts Halibut::HAL::Resources to JSON encoded strings and back.
+  #
+  #     resource = Halibut::Builder.new('http://example.com') do
+  #       link "posts", '/posts'
+  #       link "author", 'http://locks.io'
+  #
+  #       property "title", 'Entry point'
+  #     end.resource
+  #
+  #     dumped = Halibut::Adapter::JSON.dump resource
+  #     # => "{\"title\":\"Entry point\",\"_links\":{\"self\":{\"href\":\"http://example.com\"},\"posts\":{\"href\":\"/posts\"},\"author\":{\"href\":\"http://locks.io\"}}}"
+  #
+  #     loaded = Halibut::Adapter::JSON.load dumped
+  #     resource == loaded
+  #     # => true
+  #
   module JSON
-    def self.load(json)
+
+    # Returns an Halibut::HAL::Resource from a JSON string
+    def self.parse(json)
       ResourceExtractor.new(json).resource
     end
 
+    # Returns a JSON string representation of an Halibut::HAL::Resource
     def self.dump(resource)
       MultiJson.dump resource.to_hash
     end
 
     private
+
+    # @deprecated Please use Halibut::Adapter::JSON.dump instead.
     def self.extended(base)
       base.extend InstanceMethods
     end
 
     module InstanceMethods
+      # @deprecated This might go.
       def to_json
+        warn "[Deprecation] Don't depend on this, as it might disappear soon."
         MultiJson.dump self.to_hash
       end
     end
 
+    # ResourceExtractor is responsible for deserializing an HAL resource
+    # from the JSON representation.
+    #
+    #     extractor = ResourceExtractor.new({})
+    #     # => #<Halibut::Adapter::JSON::ResourceExtractor:0x007f8adb92f2a8
+    #     extractor.resource
+    #     # => #<Halibut::HAL::Resource:0x007f8add058fb0
+    #
     class ResourceExtractor
+
+      # Straight-forward, just pass in the JSON string you want to extract the
+      # resource from.
+      #
+      #     json = '{"_links":{"self":{"href":"http://example.com"}}}'
+      #     ResourceExtractor.new('{}')
+      #
       def initialize(json)
         @halibut = Halibut::Core::Resource.new
         @json    = MultiJson.load(json)
@@ -34,6 +71,7 @@ module Halibut::Adapter
         extract_embedded_resources
       end
 
+      # This method should be called when the the resource extracted is needed
       def resource
         @halibut
       end
@@ -68,7 +106,7 @@ module Halibut::Adapter
           embeds = ([] << values).flatten
 
           embeds.map  {|embed| MultiJson.dump embed                     }
-                .map  {|embed| Halibut::Adapter::JSON.load embed        }
+                .map  {|embed| Halibut::Adapter::JSON.parse embed       }
                 .each {|embed| @halibut.embed_resource(relation, embed) }
         end
       end

data/lib/halibut/builder.rb

@@ -125,6 +125,5 @@ module Halibut
         @resource.embed_resource(@rel, embedded.resource)
       end
     end
-
   end
 end

data/lib/halibut/core.rb

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

data/lib/halibut/core/link.rb

@@ -135,5 +135,4 @@ module Halibut::Core
       end
     end
   end
-
 end

data/lib/halibut/core/resource.rb

@@ -1,4 +1,5 @@
 require 'halibut/core/relation_map'
+require 'halibut/core/link'
 
 module Halibut::Core
 

data/lib/halibut/link_relation.rb

@@ -23,7 +23,5 @@ module Halibut
     def to_s
       @curie and "#{@curie}:#{@name}" or @name
     end
-
   end
-
-end
+end

data/lib/halibut/version.rb

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

data/spec/adapter/json_spec.rb

@@ -17,7 +17,7 @@ describe Halibut::Adapter::JSON do
   end
 
   it "deserializes from JSON" do
-    subject = Halibut::Adapter::JSON.load(load_json "serialize")
+    subject = Halibut::Adapter::JSON.parse(load_json "serialize")
 
     order = Halibut::Core::Resource.new "/orders/123"
     order.set_property "total", 30.00
@@ -36,7 +36,7 @@ describe Halibut::Adapter::JSON do
   end
 
   it "provides to_json helper" do
-    json = Halibut::Adapter::JSON.load(load_json "serialize")
+    json = Halibut::Adapter::JSON.parse(load_json "serialize")
     json = Halibut::Adapter::JSON.dump(json)
 
     order = Halibut::Core::Resource.new "/orders/123"
@@ -61,7 +61,7 @@ describe Halibut::Adapter::JSON do
     files  = read_files[]
 
     refilled  = files.map {|f| MultiJson.load f }
-    resources = files.map {|f| Halibut::Adapter::JSON.load f }.map &:to_hash
+    resources = files.map {|f| Halibut::Adapter::JSON.parse f }.map &:to_hash
 
     zipped = refilled.zip resources
     zipped.each do |json, hal|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: halibut
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Ricardo Mendes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-14 00:00:00.000000000 Z
+date: 2013-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -24,20 +24,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: addressable
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -137,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.0
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: A HAL parser and builder for use in Hypermedia APIs
@@ -154,4 +140,3 @@ test_files:
 - spec/fixtures/simple.json
 - spec/link_relation_spec.rb
 - spec/spec_helper.rb
-has_rdoc: