hyperclient 0.0.1

data/.rvmrc

@@ -0,0 +1 @@
+rvm ruby-1.9.2-p180-patched@hyperclient --create

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Mike Subelsky
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,71 @@
+# Hyperclient
+
+This gem aims to explore and demonstrate how to write a client for [hypermedia APIs](http://blog.steveklabnik.com/posts/2012-02-23-rest-is-over), formerly
+known as REST interfaces that respect the [HATEOAS constraint](http://roy.gbiv.com/untangled/2008/rest-apis-must-be-hypertext-driven).
+
+Many people have demonstrated how the server should respond. I'm investigating how the client should behave when interacting with a true hypermedia server.
+
+The gem is being developed against the [Hypertext Application Language](http://stateless.co/hal_specification.html) and [Atompub](http://bitworking.org/projects/atom/rfc5023.html) specifications.
+
+Contributors welcome!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hyperclient'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hyperclient
+
+## Usage
+
+```ruby
+require 'hyperclient'
+
+# NOTE this is the only URI you ever need to specify yourself. The server will provide all future links.
+resource = Hyperclient::Resource.new("http://api.example.com")
+
+resource.links.each { |l| puts(l.relation => l.uri) }
+# {:self => "https://api.example.com"}
+# {:orders => "https://api.example.com/orders"}
+# {:customers => "https://api.example.com/customers"}
+
+# since we're at the root level of this API we haven't drilled into any objects yet
+pp resource.objects
+# []
+
+orders_resource = resource[:orders].get
+pp orders_resource.links
+# {:self => "https://api.example.com/orders",
+#  :next => "https://api.example.com/orders/page/2"}
+
+# some servers may return embedded objects
+orders_resource.objects.each { |l| puts l.class => l.attributes }
+# [Hyperclient::Resource => {:id => 50, :item_name => "R2 Motivator", :created_at => "2012-02-03 12:15:02 -0400"},
+#  Hyperclient::Resource => {:id => 51, :item_name => "Hydrospanner", :created_at => "2012-02-04 13:18:12 -0500"}]
+
+order_resource = orders_resource.post({ item_name: "Droid Coolant" })
+pp order_resource.location
+# "https://api.example.com/orders/52"
+
+pp order_resource.attributes
+# {:id => 52, :item_name => "Droid Coolant", :created_at => "2012-03-05 21:31:04 -0500"}
+```
+
+## Contributing
+
+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
+
+## Questions?
+
+Contact me on [Twitter](https://twitter/subelsky) or [email](mike@subelsky.com).

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/hyperclient.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/hyperclient/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Mike Subelsky"]
+  gem.email         = ["mike@subelsky.com"]
+  gem.description   = %q{Proof of concept for interacting with a hypermedia API}
+  gem.summary       = %q{This client is capable of interacting with hypermedia APIs as described in http://www.subbu.org/blog/2008/09/on-linking-part-1 and elsewhere}
+  gem.homepage      = "https://github.com/subelsky/hyperclient"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "hyperclient"
+  gem.require_paths = ["lib"]
+  gem.version       = Hyperclient::VERSION
+end

data/lib/hyperclient/version.rb

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

data/lib/hyperclient.rb

@@ -0,0 +1,5 @@
+require "hyperclient/version"
+
+module Hyperclient
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: hyperclient
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Mike Subelsky
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-06 00:00:00.000000000Z
+dependencies: []
+description: Proof of concept for interacting with a hypermedia API
+email:
+- mike@subelsky.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- hyperclient.gemspec
+- lib/hyperclient.rb
+- lib/hyperclient/version.rb
+homepage: https://github.com/subelsky/hyperclient
+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: This client is capable of interacting with hypermedia APIs as described in
+  http://www.subbu.org/blog/2008/09/on-linking-part-1 and elsewhere
+test_files: []