restify 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9d43e9fc7edcf380453e49cb076f14b118370e09
+  data.tar.gz: bcbc69d8dab7eff64f174f3beadccd68fa64c19e
+SHA512:
+  metadata.gz: 27b2c9babe03123f84e6da7ef102c9e07231862a28ee6bd25f76bba6a8a8417af1cb58a81486c7652239f2ae1ca6b5ab03c93593ae2bd022c75b2dfb05d0532e
+  data.tar.gz: 3537927275ddbe60a53a610dc30573f4879d5a9b1784c31f8db844bc8a972acaeaa67ac6ac9b21701c1f418c2b773cb650177a87e11be3cf5c6c977172af6024

data/LICENSE.txt

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -0,0 +1,96 @@
+# Restify
+
+Restify is an experimental hypermedia REST client that uses parallel, keep-alive and pipelined requests by default.
+
+Restify scans Link headers and returned resource for links and relations to other resources, represented as RFC6570 URI Templates, and exposes those to the developer.
+
+Restify can be used to consume hypermedia REST APIs (like GitHubs), to build a site-specific library or to use within your own backend services.
+
+Restify is build upon
+
+* [obligation](https://github.com/jgraichen/obligation)
+* [addressable](https://github.com/sporkmonger/addressable)
+
+provided HTTP adapters for
+
+* [em-http-request](https://github.com/igrigorik/em-http-request)
+
+and can decode and encode
+
+* [JSON](https://github.com/intridea/multi_json)
+
+## Restify is still pre-alpha!
+
+* It does not cover all HTTP methods (not even all basic ones)
+* It is build on pre-alpha obligation library.
+* It has to less tests.
+
+Planned features:
+
+* API versions via header/URI
+* Content-Type and Language negotiation
+* Encode and decode MessagePack
+* ZeroMQ FLP backend
+* Eventmachine integration (see obligation library)
+* Alternative HTTP backends
+
+## Installation
+
+Add it to your Gemfile or install it manually: `$ gem install restify`
+
+## Usage
+
+Create new Restify object (actually returns '/' resource):
+
+```ruby
+client = Restify.new('http://api.github.com').value
+```
+
+The `value` call resolves the returned `Obligation` (like a Future object) by blocking the thread until the resource is there.
+
+Get a relation described by the root resource. Restify supports Link headers as well as JSON encoded relations (`*_url` fields).
+
+```ruby
+repositories = gh.rel(:repository)
+```
+
+Send a GET request for a specific repository using given parameters. They will be used to expand the URI template behind the `repositories` relation.
+
+```ruby
+repo = repositories.get(owner: 'jgraichen', repo: 'restify').value
+```
+
+Now fetch a list of commits for this repo and get this first one:
+
+```ruby
+commit = repo.rel(:commits).get.value.first
+```
+
+And print it:
+
+```ruby
+puts "Last commit: #{commit[:sha]}"
+puts "By #{commit[:commit][:author][:name]} <#{commit[:commit][:author][:email]}>"
+puts "#{commit[:commit][:message]}"
+```
+
+See commented example in main spec [`spec/restify_spec.rb`](https://github.com/jgraichen/restify/blob/master/spec/restify_spec.rb#L100) or in the `examples` directory.
+
+## Contributing
+
+1. Fork it ( http://github.com/jgraichen/restify/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit specs for your feature so that I do not break it later
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request
+
+## License
+
+Copyright (C) 2014 Jan Graichen
+
+This program is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License along with this program.  If not, see <http://www.gnu.org/licenses/>.

data/doc/file.README.html

@@ -0,0 +1,107 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+<title>
+  File: README
+  
+    &mdash; Documentation by YARD 0.8.7.4
+  
+</title>
+
+  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+
+  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '';
+  framesUrl = "frames.html#!file.README.html";
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+  
+    <a href="_index.html">Index</a> &raquo; 
+    <span class="title">File: README</span>
+  
+
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+
+      <div id="search">
+  
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+      Class List
+    </a>
+  
+    <a class="full_list_link" id="method_list_link"
+        href="method_list.html">
+      Method List
+    </a>
+  
+    <a class="full_list_link" id="file_list_link"
+        href="file_list.html">
+      File List
+    </a>
+  
+</div>
+      <div class="clear"></div>
+    </div>
+
+    <iframe id="search_frame"></iframe>
+
+    <div id="content"><div id='filecontents'><h1>Restify</h1>
+
+<p>TODO: Write a gem description</p>
+
+<h2>Installation</h2>
+
+<p>Add this line to your application&#39;s Gemfile:</p>
+
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>restify</span><span class='tstring_end'>&#39;</span></span>
+</code></pre>
+
+<p>And then execute:</p>
+
+<pre class="code ruby"><code class="ruby">$ bundle
+</code></pre>
+
+<p>Or install it yourself as:</p>
+
+<pre class="code ruby"><code class="ruby">$ gem install restify
+</code></pre>
+
+<h2>Usage</h2>
+
+<p>TODO: Write usage instructions here</p>
+
+<h2>Contributing</h2>
+
+<ol>
+<li>Fork it ( <a href="http://github.com/">http://github.com/</a><my-github-username>/restify/fork )</li>
+<li>Create your feature branch (<code>git checkout -b my-new-feature</code>)</li>
+<li>Commit your changes (<code>git commit -am &#39;Add some feature&#39;</code>)</li>
+<li>Push to the branch (<code>git push origin my-new-feature</code>)</li>
+<li>Create new Pull Request</li>
+</ol>
+</div></div>
+
+    <div id="footer">
+  Generated on Wed May  7 13:45:16 2014 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.7.4 (ruby-2.1.1).
+</div>
+
+  </body>
+</html>

data/lib/restify.rb

@@ -0,0 +1,42 @@
+require 'restify/version'
+require 'addressable/uri'
+require 'addressable/template'
+require 'active_support'
+require 'active_support/core_ext'
+require 'active_support/hash_with_indifferent_access'
+require 'active_support/core_ext/module/delegation'
+require 'multi_json'
+require 'obligation'
+
+#
+module Restify
+  require 'restify/adapter'
+  require 'restify/client'
+  require 'restify/relations'
+  require 'restify/collection'
+  require 'restify/link'
+  require 'restify/relation'
+  require 'restify/request'
+  require 'restify/resource'
+  require 'restify/response'
+
+  class << self
+    def new(url)
+      Client.new(url).request(:GET, nil)
+    end
+
+    def adapter
+      @adapter ||= Adapter::EM.new
+    end
+
+    def decode(response)
+      decoder = decoders.find { |d| d.accept?(response) }
+      if decoder
+        decoder.decode(response)
+      else
+        UnsupportedFormatError.new \
+          "Cannot decode `#{response.content_type}' response."
+      end
+    end
+  end
+end

data/lib/restify/adapter.rb

@@ -0,0 +1,74 @@
+require 'eventmachine'
+require 'em-http-request'
+
+module Restify
+  #
+  module Adapter
+    #
+    class EM
+
+      def call(request)
+        Obligation.create do |w|
+          next_tick do
+            conn = ConnectionPool.get(request.uri)
+            req  = conn.send request.method.downcase,
+                             keepalive: true,
+                             redirects: 3,
+                             path: request.uri.normalized_path,
+                             query: request.uri.normalized_query,
+                             body: request.body,
+                             head: request.headers
+
+            req.callback do
+              w.fulfill Response.new(
+                request,
+                req.response_header.status,
+                req.response_header,
+                req.response
+              )
+            end
+
+            req.errback do
+              w.reject RuntimeError.new
+            end
+          end
+        end
+      end
+
+      private
+
+      def next_tick(&block)
+        ensure_running
+        EventMachine.next_tick(&block)
+      end
+
+      def ensure_running
+        Thread.new do
+          begin
+            EventMachine.run {}
+          rescue => e
+            puts "Resitfy::Adapter::EM -> #{e}\n#{e.backtrace.join("\n")}"
+            raise e
+          end
+        end unless EventMachine.reactor_running?
+      end
+
+      #
+      class ConnectionPool
+        class << self
+          #
+          def get(uri)
+            connections[uri.origin] ||= begin
+              EventMachine::HttpRequest.new(uri.origin)
+            end
+          end
+
+          #
+          def connections
+            @connections ||= {}
+          end
+        end
+      end
+    end
+  end
+end