hateoas 0.0.1 → 0.0.2

data/.gitignore

@@ -4,3 +4,4 @@ Gemfile.lock
 pkg/*
 *.swp
 .rbx/
+docs/

data/.rvmrc

@@ -0,0 +1 @@
+rvm --create use 1.9.3@hateoas

data/.travis.yml

@@ -0,0 +1,8 @@
+script: "true" #lolz
+rvm:
+  - rbx-18mode
+  - rbx-19mode
+  - jruby
+  - 1.9.3
+  - 1.9.2
+  - 1.8.7

data/README.md

@@ -1,120 +1,31 @@
+# Hateoas
 
-About
-=====
+This is a Ruby gem that lets you interact with hypermedia APIs.
 
-HATEOAS helps you build hypermedia API clients, by providing a simple
-interface to navigate through pages, submitting forms, and caching local
-responses.
+It's very much in development. You shouldn't use it for anything other than giggles. And maybe Unicorns.
 
-The current version is 0.0.1.
+## Installation
 
-**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.**
+Add this line to your application's Gemfile:
 
-Find out more at [the hateoas homepage][homepage].
+    gem 'hateoas'
 
-Installing
-==========
+And then execute:
 
-Become a HATEr by using Rubygems:
+    $ bundle
 
-```
-gem install hateoas
-```
+Or install it yourself as:
 
-Usage
-=====
+    $ gem install hateoas
 
-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.
+## Usage
 
-Right now, HATEOAS assumes that you use XHTML5 to drive your API.
+Read the code. More to come when I feel like _anything_ is stable.
 
-Configuration
--------------
+## Contributing
 
-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
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -1 +1,48 @@
 require "bundler/gem_tasks"
+require 'rake/clean'
+
+begin
+# Bring in Rocco tasks
+require 'rocco/tasks'
+Rocco::make 'docs/'
+
+desc 'Build rocco docs'
+task :docs => :rocco
+directory 'docs/'
+
+file 'docs/index.html' => 'docs/lib/hateoas.html' do |f|
+  cp 'docs/lib/hateoas.html', 'docs/index.html', :preserve => true
+end
+task :docs => 'docs/index.html'
+CLEAN.include 'docs/index.html'
+
+# Alias for docs task
+task :doc => :docs
+
+# GITHUB PAGES ===============================================================
+
+desc 'Update gh-pages branch'
+task :pages => ['docs/.git', :docs] do
+  rev = `git rev-parse --short HEAD`.strip
+  Dir.chdir 'docs' do
+    sh "git add *.html"
+    sh "git commit -m 'rebuild pages from #{rev}'" do |ok,res|
+      if ok
+        verbose { puts "gh-pages updated" }
+        sh "git push -q o HEAD:gh-pages"
+      end
+    end
+  end
+end
+
+# Update the pages/ directory clone
+file 'docs/.git' => ['docs/', '.git/refs/heads/gh-pages'] do |f|
+  sh "cd docs && git init -q && git remote add o ../.git" if !File.exist?(f.name)
+  sh "cd docs && git fetch -q o && git reset -q --hard o/gh-pages && touch ."
+end
+CLOBBER.include 'docs/.git'
+
+rescue LoadError => e
+  puts "Something with rocco didn't load, you can't build the docs! Try bundle install?"
+end
+

data/hateoas.gemspec

@@ -19,4 +19,6 @@ Gem::Specification.new do |s|
   s.add_dependency "mechanize"
 
   s.add_development_dependency "rspec"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "pygmentize"
 end

data/lib/hateoas.rb

@@ -1,43 +1,74 @@
-require 'hateoas/version'
-require 'open-uri'
-require 'mechanize'
+require 'net/http'
+require 'uri'
+require 'forwardable'
+require 'nokogiri'
 
 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
+  module MediaType
+    def self.included(including_class)
+      including_class.class_eval do
+        def self.media_type(type)
+          @media_type = type
+        end
+
+        def self.serialization(type)
+        end
+
+        def self.element(*elements)
+        end
+
+        def self.attribute(*attributes)
+        end
+
+        def self.relation(*relations)
+        end
+
+        def self.action(*actions)
+          @actions = actions
+        end
+
+        def self.actions
+          @actions
+        end
       end
     end
 
-    def current_page
-      current_state.body
-    end
+    class Request
+      extend Forwardable
+      def_delegators :@uri, :request_uri, :hostname, :port
 
-    def current_state
-      @current_state ||= user_agent.get(base_uri)
-    end
+      def initialize(url, media_type)
+        @uri = URI(url)
+        @media_type = media_type
+      end
 
-    def user_agent
-      @user_agent ||= Mechanize.new
+      def get
+        req = Net::HTTP::Get.new(request_uri)
+        req['Accept'] = @media_type
+
+        Net::HTTP.start(hostname, port) {|http| http.request(req) }.body
+      end
     end
 
-  end
+    def media_type; @media_type; end
+    def data; @data; end
+
+    def actions
+      self.class.actions.select{|rel| relation_exists?(rel) }
+    end
 
-  module DSL
-    extend self
+    def initialize(uri)
+      @data = Nokogiri::XML(Request.new(uri, @media_type).get)
+    end
 
-    def click_link(rel)
-      if Hateoas.rel_namespace
-        rel = "/#{Hateoas.rel_namespace}/#{rel}"
-      end
+    def relation_exists?(rel)
+      @data.xpath("//*[@rel='#{rel}']").first
+    end
 
-      Hateoas.current_state = Hateoas.user_agent.click(Hateoas.current_state.links.find{|l| l.attributes["rel"] == rel })
+    def transition(rel)
+      node = @data.xpath("//*[@rel='#{rel}']").first
+      return unless node
+      @data = Nokogiri::XML(Request.new(node[:href], @media_type).get)
     end
   end
 end

data/lib/hateoas/version.rb

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

metadata

@@ -1,100 +1,98 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: hateoas
-version: !ruby/object:Gem::Version 
-  hash: 29
+version: !ruby/object:Gem::Version
+  version: 0.0.2
   prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 1
-  version: 0.0.1
 platform: ruby
-authors: 
+authors:
 - Steve Klabnik
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-11-06 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-02-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: mechanize
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70282849544420 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: *70282849544420
+- !ruby/object:Gem::Dependency
   name: rspec
+  requirement: &70282849543940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70282849543940
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70282849543520 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: *70282849543520
+- !ruby/object:Gem::Dependency
+  name: pygmentize
+  requirement: &70282849543100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70282849543100
 description: A set of tools to help build clients for Hypermedia APIs.
-email: 
+email:
 - steve@steveklabnik.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
+- .rvmrc
+- .travis.yml
 - 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: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+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 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.16
 signing_key: 
 specification_version: 3
 summary: Build easy clients for Hypermedia APIs.
 test_files: []
-

data/SPEC.md

@@ -1,146 +0,0 @@
-
-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