hateoas 0.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+*.swp
+.rbx/

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in hateoas.gemspec
+gemspec

data/README.md

@@ -0,0 +1,120 @@
+
+About
+=====
+
+HATEOAS helps you build hypermedia API clients, by providing a simple
+interface to navigate through pages, submitting forms, and caching local
+responses.
+
+The current version is 0.0.1.
+
+**THIS CODE IS TERRIBLE AND EXPERIMENTAL!!!!!1 CONSIDER IT A BRAIN DUMP. THERE ARE NO TESTS. THERE ARE NO COMMENTS. THE CODE IS HORRIBLE. PLEASE DON'T USE THIS FOR ANYTHING YET.**
+
+Find out more at [the hateoas homepage][homepage].
+
+Installing
+==========
+
+Become a HATEr by using Rubygems:
+
+```
+gem install hateoas
+```
+
+Usage
+=====
+
+Primarily, you'll use HATEOAS to help create your own gem to interact with your
+API. We'll pretend that you're writing an API to your own blogging
+software, since blogs are the Rails "Hello world" project.
+
+Right now, HATEOAS assumes that you use XHTML5 to drive your API.
+
+Configuration
+-------------
+
+The first thing you need to do is configure HATEOAS. Congratulations on
+creating a hypermedia API; it means the configuration is minimal! Simply
+assign your root URI like this:
+
+```
+Hateoas.base_uri = "http://api.hackety-hack.com"
+```
+
+HATEOAS has environment variables that make it easy to hit your local copy in
+development mode. By default, HATEOAS assumes you're using pow, and so it will
+append '.dev' onto the end of your `base_uri` when it is in development
+mode. To use something else, set the `development_base_uri`:
+
+```
+HATEOAS.develoment_base_uri = "http://localhost:9292"
+```
+
+The `HATEOAS_ENV` variable will control which configuration is used. Just like
+Rails, there are development, test, and production modes.
+
+In my own APIs, I prefer to use URIs for my rel attributes. If you also do
+this, there's an optional variable that makes using URIs simpler. Without it,
+here's how you navigate to the 'new post' page, then the 'new comments'
+page:
+
+```
+Hateoas::DSL.click_link("/rels/new-post")
+Hateoas::DSL.click_link("/rels/new-comments")
+```
+
+And with it:
+
+```
+Hateoas.rel_namespace = "rels"
+
+Hateoas::DSL.click_link("new-post")
+Hateoas::DSL.click_link("new-comments")
+```
+
+Groovy?
+
+DSL
+---
+
+HATEOAS provides a `DSL` module with all of the DSL methods you'll need. You
+can use these methods in two ways: One is to reference them by using their fully
+qualified names:
+
+```
+Hateoas::DSL.click_link("new-post")
+```
+
+Optionally, if you're building your own infrastructure around all of this, you
+can include the module inside your own class:
+
+```
+class MyApi
+  include Hateoas::DSL
+
+  def navigate(path)
+    click_link(path)
+  end
+end
+```
+
+The rest of this documentation will simply use `visit` rather than
+`Hateoas::DSL.visit`.
+
+Navigation
+----------
+
+If you read the previous section, you've got this one figured out: simply give
+a rel to the `click_link` method:
+
+```
+click_link("new-post")
+```
+
+Getting Data Back
+-----------------
+
+You can access the data on the current page by using the `current_page`
+method.
+
+[homepage]: http://steveklabnik.github.com/cereal

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/SPEC.md

@@ -0,0 +1,146 @@
+
+About
+=====
+
+HATEOAS helps you build hypermedia API clients, by providing a simple
+interface to navigate through pages, submitting forms, and caching local
+responses.
+
+The current version is 0.0.1.
+
+Find out more at [the hateoas homepage][homepage].
+
+Installing
+==========
+
+Become a HATEr by using Rubygems:
+
+```
+gem install hateoas
+```
+
+Usage
+=====
+
+Primarily, you'll use HATEOAS to help create your own gem to interact with your
+API. We'll pretend that you're writing an API to your own blogging
+software, since blogs are the Rails "Hello world" project.
+
+Right now, HATEOAS assumes that you use XHTML5 to drive your API.
+
+Configuration
+-------------
+
+The first thing you need to do is configure HATEOAS. Congratulations on
+creating a hypermedia API; it means the configuration is minimal! Simply
+assign your root URI like this:
+
+```
+Hateoas.base_uri = "http://api.hackety-hack.com"
+```
+
+HATEOAS has environment variables that make it easy to hit your local copy in
+development mode. By default, HATEOAS assumes you're using pow, and so it will
+append '.dev' onto the end of your `base_uri` when it is in development
+mode. To use something else, set the `development_base_uri`:
+
+```
+HATEOAS.develoment_base_uri = "http://localhost:9292"
+```
+
+The `HATEOAS_ENV` variable will control which configuration is used. Just like
+Rails, there are development, test, and production modes.
+
+In my own APIs, I prefer to use URIs for my rel attributes. If you also do
+this, there's an optional variable that makes using URIs simpler. Without it,
+here's how you navigate to the 'new post' page, then the 'new comments'
+page:
+
+```
+Hateoas::DSL.click_link("/rels/new-post")
+Hateoas::DSL.click_link("/rels/new-comments")
+```
+
+And with it:
+
+```
+Hateoas.rel_namespace = "rels"
+
+Hateoas::DSL.click_link("new-post")
+Hateoas::DSL.click_link("new-comments")
+```
+
+Groovy?
+
+DSL
+---
+
+HATEOAS provides a `DSL` module with all of the DSL methods you'll need. You
+can use these methods in two ways: One is to reference them by using their fully
+qualified names:
+
+```
+Hateoas::DSL.click_link("new-post")
+```
+
+Optionally, if you're building your own infrastructure around all of this, you
+can include the module inside your own class:
+
+```
+class MyApi
+  include Hateoas::DSL
+
+  def navigate(path)
+    click_link(path)
+  end
+end
+```
+
+The rest of this documentation will simply use `visit` rather than
+`Hateoas::DSL.visit`.
+
+Navigation
+----------
+
+If you read the previous section, you've got this one figured out: simply give
+a rel to the `click_link` method:
+
+```
+click_link("new-post")
+```
+
+Getting Data Back
+-----------------
+
+You can access the data on the current page by using the `current_page`
+method.
+
+Forms
+-----
+
+There are a few methods to interact with forms:
+
+```
+fill_in('First Name', :with => 'John')
+fill_in('Password', :with => 'Seekrit')
+fill_in('Description', :with => 'Really Long Text...')
+choose('A Radio Button')
+check('A Checkbox')
+uncheck('A Checkbox')
+attach_file('Image', '/path/to/image.jpg')
+select('Option', :from => 'Select Box')
+```
+
+Caching
+-------
+
+HATEOAS includes a client-side cache, and respects HTTP caching directives.
+This helps with performance, and keeps network connections down.
+
+Authorization
+-------------
+
+Authentication
+--------------
+
+[homepage]: http://steveklabnik.github.com/cereal

data/hateoas.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "hateoas/version"
+
+Gem::Specification.new do |s|
+  s.name        = "hateoas"
+  s.version     = Hateoas::VERSION
+  s.authors     = ["Steve Klabnik"]
+  s.email       = ["steve@steveklabnik.com"]
+  s.homepage    = "http://steveklabnik.github.com/hateoas"
+  s.summary     = %q{Build easy clients for Hypermedia APIs.}
+  s.description = %q{A set of tools to help build clients for Hypermedia APIs.}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "mechanize"
+
+  s.add_development_dependency "rspec"
+end

data/lib/hateoas.rb

@@ -0,0 +1,43 @@
+require 'hateoas/version'
+require 'open-uri'
+require 'mechanize'
+
+module Hateoas
+  class << self
+    attr_accessor :rel_namespace
+    attr_writer :base_uri, :current_state
+
+    def base_uri
+      if ENV['HATEOAS_ENV'] == "development"
+        development_base_uri || "#{@base_uri}.dev"
+      else
+        @base_uri
+      end
+    end
+
+    def current_page
+      current_state.body
+    end
+
+    def current_state
+      @current_state ||= user_agent.get(base_uri)
+    end
+
+    def user_agent
+      @user_agent ||= Mechanize.new
+    end
+
+  end
+
+  module DSL
+    extend self
+
+    def click_link(rel)
+      if Hateoas.rel_namespace
+        rel = "/#{Hateoas.rel_namespace}/#{rel}"
+      end
+
+      Hateoas.current_state = Hateoas.user_agent.click(Hateoas.current_state.links.find{|l| l.attributes["rel"] == rel })
+    end
+  end
+end

data/lib/hateoas/version.rb

@@ -0,0 +1,3 @@
+module Hateoas
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification 
+name: hateoas
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Steve Klabnik
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-11-06 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mechanize
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: A set of tools to help build clients for Hypermedia APIs.
+email: 
+- steve@steveklabnik.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- SPEC.md
+- hateoas.gemspec
+- lib/hateoas.rb
+- lib/hateoas/version.rb
+homepage: http://steveklabnik.github.com/hateoas
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Build easy clients for Hypermedia APIs.
+test_files: []
+