hypermedia 1.0.0

data/lib/api/api.rb

@@ -0,0 +1,25 @@
+# encoding: UTF-8
+
+module HypermediaAPI
+  require 'nokogiri'
+  require 'httparty'
+  include HTTParty
+  
+  BadURI = Class.new(Exception)
+  MissingForm = Class.new(Exception)
+  
+  class Parser < HTTParty::Parser
+    require 'nokogiri'
+    
+    SupportedFormats.merge!('text/html' => :html)
+    
+    def html
+      Nokogiri::HTML(body)
+    end
+  end
+  
+  def HypermediaAPI.included (subclass)
+    subclass.send :include, HTTParty
+    subclass.parser HypermediaAPI::Parser
+  end
+end

data/lib/api/document.rb

@@ -0,0 +1,37 @@
+# encoding: UTF-8
+
+class HypermediaAPI::Document
+  include HypermediaAPI
+  
+  def Document.click (url)
+    response = Document.get(url)
+    Document.new(response)
+  end
+  
+  def form (css_selector)
+    if form_element = @document.css(css_selector).first
+      action_uri = form_element['action']
+      http_method = form_element['method'].downcase
+      
+      Form.new(action_uri, http_method)
+    else
+      raise MissingForm, "The API does not have a form matching '#{css_selector}' at #{@document.path}."
+    end
+  end
+  
+  def headers
+    @document.headers
+  end
+  
+  def html
+    @document.to_html
+  end
+  
+  def initialize (httparty_nokogiri_document)
+    @document = httparty_nokogiri_document
+  end
+  
+  def status
+    @document.code
+  end
+end

data/lib/api/form.rb

@@ -0,0 +1,21 @@
+# encoding: UTF-8
+
+class HypermediaAPI::Form
+  include HypermediaAPI
+  
+  def initialize (action_uri, http_method)
+    @action_uri = action_uri
+    @http_method = http_method.downcase
+  end
+  
+  def submit (inputs)
+    case @http_method
+      when 'post' then response = Form.post(@action_uri, body: inputs)
+    end
+    
+    HypermediaAPI::Document.new(response)
+    
+  rescue SocketError
+    raise BadURI, "The client was unable to interact with a resource at #{@action_uri}."
+  end
+end

data/lib/api/model.rb

@@ -0,0 +1,26 @@
+# encoding: UTF-8
+
+class HypermediaAPI::Model
+  def self.new_from_fields (field_elements)
+    instance = self.new
+    
+    field_elements.each do |field_element|
+      value_str = field_element.inner_html
+      name = field_element['data-name']
+      
+      value = case field_element['data-type']
+        when 'date' then value_str.empty? ? nil : Date.parse(value_str)
+        when 'integer' then value_str.empty? ? nil : value_str.to_i
+        when 'float' then value_str.empty? ? nil : value_str.to_f
+        when 'boolean' then value_str.empty? ? nil : value_str != 'false'
+        when 'string' then value_str
+      end
+      
+      if instance.respond_to?(name)
+        instance.send(:"#{name}=", value)
+      end
+    end
+    
+    instance
+  end
+end

data/lib/hypermedia.rb

@@ -0,0 +1,9 @@
+# encoding: UTF-8
+
+require 'bundler/setup'
+require 'nokogiri'
+
+require_relative 'api/api.rb'
+require_relative 'api/document.rb'
+require_relative 'api/form.rb'
+require_relative 'api/model.rb'

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: hypermedia
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Jesse Sielaff
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-15 00:00:00.000000000 Z
+dependencies: []
+description: .
+email: jesse@myenergy.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ./lib/api/api.rb
+- ./lib/api/document.rb
+- ./lib/api/form.rb
+- ./lib/api/model.rb
+- ./lib/hypermedia.rb
+homepage: 
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: A client builder for HTML5-based HATEOAS APIs.
+test_files: []