hyperclient 0.0.8 → 0.1.0

data/lib/hyperclient/http.rb

@@ -1,5 +1,5 @@
 require 'httparty'
-require 'forwardable'
+require 'json'
 
 # Public: A parser for HTTParty that understand the mime application/hal+json.
 class JSONHalParser < HTTParty::Parser
@@ -10,30 +10,45 @@ module Hyperclient
   # Internal: This class wrapps HTTParty and performs the HTTP requests for a
   # resource.
   class HTTP
-    extend Forwardable
     include HTTParty
-
     parser JSONHalParser
 
-    # Private: Delegate the url to the resource.
-    def_delegators :@resource, :url
-
-    # Public: Initializes a HTTP agent.
+    # Public: Initializes the HTTP agent.
     #
-    # resource - A Resource instance. A Resource is given instead of the url
-    # since the resource url could change during its live.
-    def initialize(resource, options = {})
-      @resource = resource
-      authenticate(options[:auth]) if options && options.include?(:auth)
-      headers(options[:headers]) if options && options.include?(:headers)
-      enable_debug(options[:debug]) if options && options.include?(:debug)
+    # url    - A String to send the HTTP requests.
+    # config - A Hash with the configuration of the HTTP connection.
+    #          :headers - The Hash with the headers of the connection.
+    #          :auth    - The Hash with the authentication options:
+    #            :type     - A String or Symbol to set the authentication type.
+    #                        Allowed values are :digest or :basic.
+    #            :user     - A String with the user.
+    #            :password - A String with the user.
+    #          :debug   - The flag (true/false) to debug the HTTP connections.
+    #
+    def initialize(url, config)
+      @url      = url
+      @config   = config
+      @base_uri = config.fetch(:base_uri)
+
+      authenticate!
+      toggle_debug! if @config[:debug]
+
+      self.class.headers(@config[:headers]) if @config.include?(:headers)
+    end
+
+    def url
+      begin
+        URI.parse(@base_uri).merge(@url).to_s
+      rescue URI::InvalidURIError
+        @url
+      end
     end
 
     # Public: Sends a GET request the the resource url.
     #
     # Returns: The parsed response.
     def get
-      self.class.get(url).parsed_response
+      JSON.parse(self.class.get(url).response.body)
     end
 
     # Public: Sends a POST request the the resource url.
@@ -79,34 +94,20 @@ module Hyperclient
     # Internal: Sets the authentication method for HTTParty.
     #
     # options - An options Hash to set the authentication options.
-    #           :type        - A String or Symbol to set the authentication type.
-    #           Can be either :digest or :basic.
-    #           :credentials - An Array of Strings with the user and password.
     #
     # Returns nothing.
-    def authenticate(options)
-      auth_method = options[:type].to_s + '_auth'
-      self.class.send(auth_method, *options[:credentials])
-    end
-
-    # Internal: Adds default headers for all the requests.
-    #
-    # headers - A Hash with the header.
-    #
-    # Example:
-    #   headers({'accept-encoding' => 'deflate, gzip'})
-    #
-    # Returns nothing.
-    def headers(headers)
-      self.class.send(:headers, headers)
+    def authenticate!
+      if (options = @config[:auth])
+        auth_method = options.delete(:type).to_s + '_auth'
+        self.class.send(auth_method, options[:user], options[:password])
+      end
     end
 
     # Internal: Enables HTTP debugging.
     #
-    # stream - An object to stream the HTTP out to or just a truthy value. If
-    #          it's truthy it will output to $stderr.
-    def enable_debug(stream)
-      return unless stream
+    # stream - An object to stream the HTTP out to or just a truthy value. 
+    def toggle_debug!
+      stream = @config[:debug]
 
       if stream.respond_to?(:<<)
         self.class.debug_output(stream)

data/lib/hyperclient/link.rb

@@ -0,0 +1,93 @@
+require 'hyperclient/http'
+require 'hyperclient/resource'
+require 'uri_template'
+
+module Hyperclient
+  # Internal: The Link is  used to let a Resource interact with the API.
+  #
+  class Link
+    extend Forwardable
+    # Public: Delegate all HTTP methods (get, post, put, delete, options and
+    # head) to the http connection.
+    def_delegators :http, :get, :post, :put, :delete, :options, :head
+
+    # Public: Initializes a new Link.
+    #
+    # link          - The String with the URI of the link.
+    # entry_point   - The EntryPoint object to inject the cofnigutation.
+    # uri_variables - The optional Hash with the variables to expand the link
+    #                 if it is templated.
+    def initialize(link, entry_point, uri_variables = nil)
+      @link          = link
+      @entry_point   = entry_point
+      @uri_variables = uri_variables
+    end
+
+    # Public: Returns the Resource which the Link is pointing to.
+    def resource
+      @resource ||=Resource.new(http.get, @entry_point)
+    end
+
+    # Public: Indicates if the link is an URITemplate or a regular URI.
+    #
+    # Returns true if it is templated.
+    # Returns false if it nos templated.
+    def templated?
+      !!@link['templated']
+    end
+
+    # Public: Expands the Link when is templated with the given variables.
+    #
+    # uri_variables - The Hash with the variables to expand the URITemplate.
+    #
+    # Returns a new Link with the expanded variables.
+    def expand(uri_variables)
+      self.class.new(@link, @entry_point, uri_variables)
+    end
+
+    # Public: Returns the url of the Link.
+    #
+    # Raises MissingURITemplateVariables if the Link is templated but there are
+    # no uri variables to expand it.
+    def url
+      return @link['href'] unless templated?
+      raise MissingURITemplateVariablesException if @uri_variables == nil
+
+      @url ||= URITemplate.new(@link['href']).expand(@uri_variables)
+    end
+
+    private
+    # Internal: Returns the HTTP client used to interact with the API.
+    def http
+      @http ||= HTTP.new(url, @entry_point.config)
+    end
+
+    # Internal: Delegate the method to the API if it exists.
+    #
+    # This allows `api.links.posts.embedded` instead of
+    # `api.links.posts.resource.embedded`
+    def method_missing(method, *args, &block)
+      if resource.respond_to?(method)
+        resource.send(method, *args, &block)
+      else
+        super
+      end
+    end
+
+    # Internal: Accessory method to allow the link respond to the
+    # methods that will hit method_missing.
+    def respond_to_missing?(method, include_private = false)
+      resource.respond_to?(method.to_s)
+    end
+  end
+
+  # Public: Exception that is raised when building a templated Link without uri
+  # variables.
+  class MissingURITemplateVariablesException < StandardError
+
+    # Public: Returns a String with the exception message.
+    def message
+      "The URL to this links is templated, but no variables where given."
+    end
+  end
+end

data/lib/hyperclient/link_collection.rb

@@ -0,0 +1,24 @@
+require 'hyperclient/collection'
+require 'hyperclient/link'
+
+module Hyperclient
+  # Public: A wrapper class to easily acces the links in a  Resource.
+  #
+  # Examples
+  #
+  #   resource.links['author']
+  #   resource.links.author
+  #
+  class LinkCollection < Collection
+    # Public: Initializes a LinkCollection.
+    #
+    # collection  - The Hash with the links.
+    # entry_point - The EntryPoint object to inject the cofnigutation.
+    #
+    def initialize(collection, entry_point)
+      @collection = (collection || {}).inject({}) do |hash, (name, link)|
+        hash.update(name => Link.new(link, entry_point))
+      end
+    end
+  end
+end

data/lib/hyperclient/resource.rb

@@ -1,81 +1,42 @@
-require 'hyperclient/representation'
-require 'hyperclient/http'
+require 'hyperclient/attributes'
+require 'hyperclient/link_collection'
+require 'hyperclient/resource_collection'
 
 module Hyperclient
   # Public: Represents a resource from your API. Its responsability is to
-  # perform HTTP requests against itself and ease the way you access the
-  # resource's attributes, links and embedded resources.
+  # ease the way you access its  attributes, links and embedded resources.
   class Resource
     extend Forwardable
-    # Public: Delegate attributes and resources to the representation.
-    def_delegators :representation, :attributes, :embedded, :links
 
-    # Public: Delegate all HTTP methods (get, post, put, delete, options and
-    # head) to Hyperclient::HTTP.
-    def_delegators :@http, :get, :post, :put, :delete, :options, :head
+    # Public: Returns the attributes of the Resource as Attributes.
+    attr_reader :attributes
 
-    # Public: A String representing the Resource name.
-    attr_reader :name
+    # Public: Returns the links of the Resource as a LinkCollection.
+    attr_reader :links
 
-    # Public: Initializes a Resource.
-    #
-    # url - A String with the url of the resource. Can be either absolute or
-    # relative.
-    #
-    # options - An options Hash to initialize different values:
-    #           :name     - The String name of the resource.
-    #           :representation - An optional Hash representation of the resource's 
-    #           HTTP representation.
-    #           :http     - An optional Hash to pass to the HTTP class.
-    def initialize(url, options = {})
-      @url = url
-      @name = options[:name]
-      @http = HTTP.new(self, options[:http])
-      initialize_representation(options[:representation])
-    end
-
-    # Public: Sets the entry point for all the resources in your API client.
-    #
-    # url - A String with the URL of your API entry point.
-    #
-    # Returns nothing.
-    def self.entry_point=(url)
-      @@entry_point = URI(url)
-    end
+    # Public: Returns the embedded resource of the Resource as a
+    # ResourceCollection.
+    attr_reader :embedded
 
-    # Public: Returns A String representing the resource url.
-    def url
-      begin
-        @@entry_point.merge(@url).to_s
-      rescue URI::InvalidURIError
-        @url
-      end
-    end
+    # Public: Delegate all HTTP methods (get, post, put, delete, options and
+    # head) to its Link.
+    def_delegators :self_link, :get, :post, :put, :delete, :options, :head
 
-    # Public: Gets a fresh representation from the resource representation.
-    #
-    # Returns itself (this way you can chain method calls).
-    def reload
-      initialize_representation(get)
-      self
+    # Public: Initializes a Resource.
+    # representation - The hash with the HAL representation of the Resource.
+    # entry_point    - The EntryPoint object to inject the cofnigutation.
+    def initialize(representation, entry_point)
+      @links       = LinkCollection.new(representation['_links'], entry_point)
+      @embedded    = ResourceCollection.new(representation['_embedded'], entry_point)
+      @attributes  = Attributes.new(representation)
+      @entry_point = entry_point
     end
 
     private
-    # Internal: Initializes a Representation
-    #
-    # raw_representation - A Hash representing the HTTP representation for the resource.
-    #
-    # Return nothing.
-    def initialize_representation(raw_representation)
-      if raw_representation && !raw_representation.empty?
-        @representation = Representation.new(raw_representation)
-      end
-    end
-
-    # Internal: Returns the resource representation.
-    def representation
-      reload unless @representation
-      @representation
+    # Internal: Returns the self Link of the Resource. Used to handle the HTTP
+    # connections.
+    def self_link
+      @links['self']
     end
   end
 end

data/lib/hyperclient/resource_collection.rb

@@ -0,0 +1,33 @@
+require 'hyperclient/collection'
+require 'hyperclient/resource'
+
+module Hyperclient
+  # Public: A wrapper class to easily acces the embedded resources in a
+  # Resource.
+  #
+  # Examples
+  #
+  #   resource.embedded['comments']
+  #   resource.embedded.comments
+  #
+  class ResourceCollection < Collection
+    # Public: Initializes a ResourceCollection.
+    #
+    # collection  - The Hash with the embedded resources.
+    # entry_point - The EntryPoint object to inject the cofnigutation.
+    #
+    def initialize(collection, entry_point)
+      @entry_point = entry_point
+      @collection = (collection || {}).inject({}) do |hash, (name, resource)|
+        hash.update(name => build_resource(resource))
+      end
+    end
+
+    private
+    def build_resource(representation)
+      return representation.map(&method(:build_resource)) if representation.is_a?(Array)
+
+      Resource.new(representation, @entry_point)
+    end
+  end
+end

data/lib/hyperclient/version.rb

@@ -1,3 +1,3 @@
 module Hyperclient
-  VERSION = "0.0.8"
+  VERSION = "0.1.0"
 end

data/test/fixtures/element.json

@@ -4,7 +4,8 @@
             "href": "/productions/1"
         },
         "filter": {
-            "href": "/productions/1?categories="
+            "href": "/productions/1?categories={filter}",
+            "templated": true
         }
     },
     "title": "Real World ASP.NET MVC3",
@@ -25,16 +26,10 @@
                     "self": {
                         "href": "/episodes/1"
                     },
-                    "media": [
-                        {
+                    "media": {
                             "type": "video/webm; codecs='vp8.0, vorbis'",
                             "href": "/media/1"
-                        },
-                        {
-                            "type": "video/ogg; codecs='theora, vorbis'",
-                            "href": "/media/2"
                         }
-                    ]
                 },
                 "title": "Foundations",
                 "description": "In this episode we talk about what it is we're doing: building our startup and getting ourselves off the ground. We take..",
@@ -45,16 +40,10 @@
                     "self": {
                         "href": "/episodes/2"
                     },
-                    "media": [
-                        {
-                            "type": "video/webm; codecs='vp8.0, vorbis'",
-                            "href": "/media/3"
-                        },
-                        {
+                    "media": {
                             "type": "video/ogg; codecs='theora, vorbis'",
                             "href": "/media/4"
                         }
-                    ]
                 },
                 "title": "Membership",
                 "description": "In this episode Rob hooks up testing in an effort to deal with ASP.NET Membership. The team has decided..",

data/test/hyperclient/attributes_test.rb

@@ -0,0 +1,26 @@
+require_relative '../test_helper'
+require 'hyperclient/attributes'
+
+module Hyperclient
+  describe Attributes do
+    let(:representation) do
+      JSON.parse( File.read('test/fixtures/element.json'))
+    end
+
+    let(:attributes) do
+      Attributes.new(representation)
+    end
+
+    it 'does not set _links as an attribute' do
+      attributes.wont_respond_to :_links
+    end
+
+    it 'does not set _embedded as an attribute' do
+      attributes.wont_respond_to :_embedded
+    end
+
+    it 'is a collection' do
+      Attributes.ancestors.must_include Collection
+    end
+  end
+end