RubyGems - acfs - Versions diffs - 0.27.0.1.b248 → 0.28.0 - Diffend - OSS supply chain security and management platform

acfs 0.27.0.1.b248 → 0.28.0

Files changed (17) hide show

checksums.yaml CHANGED

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZTgwOTRmNjQ2MGNjY2M4MjBmYTBlMmVmOGIyYTAwNWRhMTlkNzFmOQ==
-  data.tar.gz: !binary |-
-    YjBkZTQ0ZWMzY2Q3OWQ4N2U1MjczZTdkYjhkMmI3NGMwMmExNWQ3ZA==
+SHA1:
+  metadata.gz: 98eda5967f361039a7f8a9385833ca64624b67df
+  data.tar.gz: 88d36bab133493be788ee548d2f070218faa2a7f
 SHA512:
-  metadata.gz: !binary |-
-    ZWQ1NTgwOTE0MTMxY2RkN2ExMjEzN2M0MmUzZjkwODQ4MWMwODY0NzkyMDBm
-    NmNiZTNhZDRkOGJiM2Q1OGFjZGJlMWQxMGFkODA2MTg5NTg4YTQwNThhNTEx
-    Yjc5YTNlMzBlOWFlZDFjNzU3NDQxZDU2OWRlYTg3MTI5ZmExMzg=
-  data.tar.gz: !binary |-
-    NDIwM2ZkYWZkNTZiZjJkNjVjZmY4NTZjN2VkYTI3NTY1YzhlYWZmYmY0YzI3
-    NjYwYzliNTgwMDM4NGIxZjhmMmJlMDQzYzJjNmIwZmVlN2I4ZWFmMWRkN2My
-    MzY2Y2IwMGQwM2Q4NDc5YmQ0OTYzYjg1Y2VjOWJjMmQwYTcyZjI=
+  metadata.gz: 0a4537bc92ae5a023e1c0923494d0be2e7b242b0d5f75574f5b4f1174328a70e251d868ad97aae944e8b877205fad6c6e6c292fba83c44b8ddffb00033971681
+  data.tar.gz: 0864494675874aeb2e2dd522d306be8ef01c1d67ce3735f372953c6cfc5f1f6093a074ab6100792ae5c08d8bf5e7bbba3720e3e3d948f04f05b7e9cbb0079707

data/CHANGELOG.md CHANGED

@@ -1,5 +1,9 @@
 # Changelog
+## 0.28.0
+* Add find_by (Nicolas Fricke)
 ## 0.27.0
 * Reset method to clear stubs, request queues, internal state

data/acfs.gemspec CHANGED

@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/jgraichen/acfs'
   spec.license       = 'MIT'
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = Dir['**/*'].grep(%r{^((bin|lib|test|spec|features)/|.*\.gemspec|.*LICENSE.*|.*README.*|.*CHANGELOG.*)})
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = %w(lib)

data/doc/file.README.html ADDED

@@ -0,0 +1,307 @@
+<!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.6.1
+</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#!" + escape(window.location.href);
+</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>Acfs - <em>API client for services</em></h1>
+<p><a href="http://badge.fury.io/rb/acfs"><img src="https://badge.fury.io/rb/acfs.png" alt="Gem Version"></a>
+<a href="https://travis-ci.org/jgraichen/acfs"><img src="https://travis-ci.org/jgraichen/acfs.png?branch=master" alt="Build Status"></a>
+<a href="https://coveralls.io/r/jgraichen/acfs"><img src="https://coveralls.io/repos/jgraichen/acfs/badge.png?branch=master" alt="Coverage Status"></a>
+<a href="https://codeclimate.com/github/jgraichen/acfs"><img src="https://codeclimate.com/github/jgraichen/acfs.png" alt="Code Climate"></a>
+<a href="https://gemnasium.com/jgraichen/acfs"><img src="https://gemnasium.com/jgraichen/acfs.png" alt="Dependency Status"></a>
+<a href="http://rubydoc.info/github/jgraichen/acfs/master/frames"><img src="https://raw.github.com/jgraichen/acfs/master/rubydoc.png" alt="RubyDoc Documentation"></a></p>
+<p>Acfs is a library to develop API client libraries for single services within a larger service oriented application.</p>
+<p>Acfs covers model and service abstraction, convenient query and filter methods, full middleware stack for pre-processing requests and responses on a per service level and automatic request queuing and parallel processing. See Usage for more.</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'>acfs</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>~&gt; 0.16.0</span><span class='tstring_end'>&#39;</span></span>
+</code></pre>
+<p><strong>Note:</strong> Acfs is under development. I&#39;ll try to avoid changes to the public API but internal APIs may change quite often.</p>
+<p>And then execute:</p>
+<pre class="code ruby"><code class="ruby">&gt; bundle
+</code></pre>
+<p>Or install it yourself as:</p>
+<pre class="code ruby"><code class="ruby">&gt; gem install acfs
+</code></pre>
+<h2>Usage</h2>
+<p>First you need to define your service(s):</p>
+<pre class="code ruby"><code class="ruby"><span class='kw'>class</span> <span class='const'>UserService</span> <span class='op'>&lt;</span> <span class='const'>Acfs</span><span class='op'>::</span><span class='const'>Service</span>
+  <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_base_url'>base_url</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>http://users.myapp.org</span><span class='tstring_end'>&#39;</span></span>
+  <span class='comment'># You can configure middlewares you want to use for the service here.
+</span>  <span class='comment'># Each service has it own middleware stack.
+</span>  <span class='comment'>#
+</span>  <span class='id identifier rubyid_use'>use</span> <span class='const'>Acfs</span><span class='op'>::</span><span class='const'>Middleware</span><span class='op'>::</span><span class='const'>JsonDecoder</span>
+  <span class='id identifier rubyid_use'>use</span> <span class='const'>Acfs</span><span class='op'>::</span><span class='const'>Middleware</span><span class='op'>::</span><span class='const'>MessagePackDecoder</span>
+<span class='kw'>end</span>
+</code></pre>
+<p>This specifies where the <code>UserService</code> is located. You can now create some models representing resources served by the <code>UserService</code>.</p>
+<pre class="code ruby"><code class="ruby"><span class='kw'>class</span> <span class='const'>User</span>
+  <span class='id identifier rubyid_include'>include</span> <span class='const'>Acfs</span><span class='op'>::</span><span class='const'>Model</span>
+  <span class='id identifier rubyid_service'>service</span> <span class='const'>UserService</span> <span class='comment'># Associate `User` model with `UserService`.
+</span>
+  <span class='comment'># Define model attributes and types
+</span>  <span class='comment'># Types are needed to parse and generate request and response payload.
+</span>
+  <span class='id identifier rubyid_attribute'>attribute</span> <span class='symbol'>:id</span><span class='comma'>,</span> <span class='symbol'>:uuid</span> <span class='comment'># Types can be classes or symbols.
+</span>                       <span class='comment'># Symbols will be used to load a class from `Acfs::Model::Attributes` namespace.
+</span>                       <span class='comment'># Eg. `:uuid` will load class `Acfs::Model::Attributes::Uuid`.
+</span>
+  <span class='id identifier rubyid_attribute'>attribute</span> <span class='symbol'>:name</span><span class='comma'>,</span> <span class='symbol'>:string</span><span class='comma'>,</span> <span class='label'>default:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Anonymous</span><span class='tstring_end'>&#39;</span></span>
+  <span class='id identifier rubyid_attribute'>attribute</span> <span class='symbol'>:age</span><span class='comma'>,</span> <span class='op'>::</span><span class='const'>Acfs</span><span class='op'>::</span><span class='const'>Model</span><span class='op'>::</span><span class='const'>Attributes</span><span class='op'>::</span><span class='const'>Integer</span> <span class='comment'># Or use :integer
+</span>
+<span class='kw'>end</span>
+</code></pre>
+<p>The service and model classes can be shipped as a gem or git submodule to be included by the frontend application(s).</p>
+<p>You can use the model there:</p>
+<pre class="code ruby"><code class="ruby"><span class='ivar'>@user</span> <span class='op'>=</span> <span class='const'>User</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span> <span class='int'>14</span>
+<span class='ivar'>@user</span><span class='period'>.</span><span class='id identifier rubyid_loaded?'>loaded?</span> <span class='comment'>#=&gt; false
+</span>
+<span class='const'>Acfs</span><span class='period'>.</span><span class='id identifier rubyid_run'>run</span> <span class='comment'># This will run all queued request as parallel as possible.
+</span>         <span class='comment'># For @user the following URL will be requested:
+</span>         <span class='comment'># `http://users.myapp.org/users/14`
+</span>
+<span class='ivar'>@model</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span> <span class='comment'># =&gt; &quot;...&quot;
+</span>
+<span class='ivar'>@users</span> <span class='op'>=</span> <span class='const'>User</span><span class='period'>.</span><span class='id identifier rubyid_all'>all</span>
+<span class='ivar'>@users</span><span class='period'>.</span><span class='id identifier rubyid_loaded?'>loaded?</span> <span class='comment'>#=&gt; false
+</span>
+<span class='const'>Acfs</span><span class='period'>.</span><span class='id identifier rubyid_run'>run</span> <span class='comment'># Will request `http://users.myapp.org/users`
+</span>
+<span class='ivar'>@users</span> <span class='comment'>#=&gt; [&lt;User&gt;, ...]
+</span></code></pre>
+<p>If you need multiple resources or dependent resources first define a &quot;plan&quot; how they can be loaded:</p>
+<pre class="code ruby"><code class="ruby"><span class='ivar'>@user</span> <span class='op'>=</span> <span class='const'>User</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span><span class='lparen'>(</span><span class='int'>5</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_user'>user</span><span class='op'>|</span>
+  <span class='comment'># Block will be executed right after user with id 5 is loaded
+</span>
+  <span class='comment'># You can load additional resources also from other services
+</span>  <span class='comment'># Eg. fetch comments from `CommentSerivce`. The line below will
+</span>  <span class='comment'># load comments from `http://comments.myapp.org/comments?user=5`
+</span>  <span class='ivar'>@comments</span> <span class='op'>=</span> <span class='const'>Comment</span><span class='period'>.</span><span class='id identifier rubyid_where'>where</span> <span class='label'>user:</span> <span class='id identifier rubyid_user'>user</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span>
+  <span class='comment'># You can load multiple resources in parallel if you have multiple
+</span>  <span class='comment'># ids.
+</span>  <span class='ivar'>@friends</span>  <span class='op'>=</span> <span class='const'>User</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span> <span class='int'>1</span><span class='comma'>,</span> <span class='int'>4</span><span class='comma'>,</span> <span class='int'>10</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_friends'>friends</span><span class='op'>|</span>
+    <span class='comment'># This block will be executed when all friends are loaded.
+</span>    <span class='comment'># [ ... ]
+</span>  <span class='kw'>end</span>
+<span class='kw'>end</span>
+<span class='const'>Acfs</span><span class='period'>.</span><span class='id identifier rubyid_run'>run</span> <span class='comment'># This call will fire all request as parallel as possible.
+</span>         <span class='comment'># The sequence above would look similar to:
+</span>         <span class='comment'>#
+</span>         <span class='comment'># Start                Fin
+</span>         <span class='comment'>#   |===================|       `Acfs.run`
+</span>         <span class='comment'>#   |====|                      /users/5
+</span>         <span class='comment'>#   |    |==============|       /comments?user=5
+</span>         <span class='comment'>#   |    |======|               /users/1
+</span>         <span class='comment'>#   |    |=======|              /users/4
+</span>         <span class='comment'>#   |    |======|               /users/10
+</span>
+<span class='comment'># Now we can access all resources:
+</span>
+<span class='ivar'>@user</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span>       <span class='comment'># =&gt; &quot;John
+</span><span class='ivar'>@comments</span><span class='period'>.</span><span class='id identifier rubyid_size'>size</span>   <span class='comment'># =&gt; 25
+</span><span class='ivar'>@friends</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span> <span class='comment'># =&gt; &quot;Miraculix&quot;
+</span></code></pre>
+<p>Acfs has basic update support using <code>PUT</code> requests:</p>
+<pre class="code ruby"><code class="ruby"><span class='ivar'>@user</span> <span class='op'>=</span> <span class='const'>User</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span> <span class='int'>5</span>
+<span class='ivar'>@user</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Bob</span><span class='tstring_end'>&quot;</span></span>
+<span class='ivar'>@user</span><span class='period'>.</span><span class='id identifier rubyid_changed?'>changed?</span> <span class='comment'># =&gt; true
+</span><span class='ivar'>@user</span><span class='period'>.</span><span class='id identifier rubyid_persisted?'>persisted?</span> <span class='comment'># =&gt; false
+</span>
+<span class='ivar'>@user</span><span class='period'>.</span><span class='id identifier rubyid_save'>save</span> <span class='comment'># Or .save!
+</span>           <span class='comment'># Will PUT new resource to service synchronously.
+</span>
+<span class='ivar'>@user</span><span class='period'>.</span><span class='id identifier rubyid_changed?'>changed?</span> <span class='comment'># =&gt; false
+</span><span class='ivar'>@user</span><span class='period'>.</span><span class='id identifier rubyid_persisted?'>persisted?</span> <span class='comment'># =&gt; true
+</span></code></pre>
+<h2>Stubbing</h2>
+<p>You can stub resources in applications using an Acfs service client:</p>
+<pre class="code ruby"><code class="ruby"><span class='comment'># Enable stubs in spec helper
+</span><span class='const'>Acfs</span><span class='op'>::</span><span class='const'>Stub</span><span class='period'>.</span><span class='id identifier rubyid_enable'>enable</span>
+<span class='id identifier rubyid_before'>before</span> <span class='kw'>do</span>
+  <span class='const'>Acfs</span><span class='op'>::</span><span class='const'>Stub</span><span class='period'>.</span><span class='id identifier rubyid_resource'>resource</span> <span class='const'>MyUser</span><span class='comma'>,</span> <span class='symbol'>:read</span><span class='comma'>,</span> <span class='label'>with:</span> <span class='lbrace'>{</span> <span class='label'>id:</span> <span class='int'>1</span> <span class='rbrace'>}</span><span class='comma'>,</span> <span class='label'>return:</span> <span class='lbrace'>{</span> <span class='label'>id:</span> <span class='int'>1</span><span class='comma'>,</span> <span class='label'>name:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>John Smith</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>age:</span> <span class='int'>32</span> <span class='rbrace'>}</span>
+  <span class='const'>Acfs</span><span class='op'>::</span><span class='const'>Stub</span><span class='period'>.</span><span class='id identifier rubyid_resource'>resource</span> <span class='const'>MyUser</span><span class='comma'>,</span> <span class='symbol'>:read</span><span class='comma'>,</span> <span class='label'>with:</span> <span class='lbrace'>{</span> <span class='label'>id:</span> <span class='int'>2</span> <span class='rbrace'>}</span><span class='comma'>,</span> <span class='label'>raise:</span> <span class='symbol'>:not_found</span>
+  <span class='const'>Acfs</span><span class='op'>::</span><span class='const'>Stub</span><span class='period'>.</span><span class='id identifier rubyid_resource'>resource</span> <span class='const'>Session</span><span class='comma'>,</span> <span class='symbol'>:create</span><span class='comma'>,</span> <span class='label'>with:</span> <span class='lbrace'>{</span> <span class='label'>ident:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>john@exmaple.org</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>password:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>s3cr3t</span><span class='tstring_end'>&#39;</span></span> <span class='rbrace'>}</span><span class='comma'>,</span> <span class='label'>return:</span> <span class='lbrace'>{</span> <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>longhash</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>user:</span> <span class='int'>1</span> <span class='rbrace'>}</span>
+<span class='kw'>end</span>
+<span class='id identifier rubyid_it'>it</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>should find user number one</span><span class='tstring_end'>&#39;</span></span> <span class='kw'>do</span>
+  <span class='id identifier rubyid_user'>user</span> <span class='op'>=</span> <span class='const'>MyUser</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span> <span class='int'>1</span>
+  <span class='const'>Acfs</span><span class='period'>.</span><span class='id identifier rubyid_run'>run</span>
+  <span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_user'>user</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be'>be</span> <span class='op'>==</span> <span class='int'>1</span>
+  <span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_user'>user</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be'>be</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>John Smith</span><span class='tstring_end'>&#39;</span></span>
+  <span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_user'>user</span><span class='period'>.</span><span class='id identifier rubyid_age'>age</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be'>be</span> <span class='op'>==</span> <span class='int'>32</span>
+<span class='kw'>end</span>
+<span class='id identifier rubyid_it'>it</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>should not find user number two</span><span class='tstring_end'>&#39;</span></span> <span class='kw'>do</span>
+  <span class='const'>MyUser</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span> <span class='int'>3</span>
+  <span class='id identifier rubyid_expect'>expect</span> <span class='lbrace'>{</span> <span class='const'>Acfs</span><span class='period'>.</span><span class='id identifier rubyid_run'>run</span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_raise_error'>raise_error</span><span class='lparen'>(</span><span class='const'>Acfs</span><span class='op'>::</span><span class='const'>ResourceNotFound</span><span class='rparen'>)</span>
+<span class='kw'>end</span>
+<span class='id identifier rubyid_it'>it</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>should allow stub resource creation</span><span class='tstring_end'>&#39;</span></span> <span class='kw'>do</span>
+  <span class='id identifier rubyid_session'>session</span> <span class='op'>=</span> <span class='const'>Session</span><span class='period'>.</span><span class='id identifier rubyid_create!'>create!</span> <span class='label'>ident:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>john@exmaple.org</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>password:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>s3cr3t</span><span class='tstring_end'>&#39;</span></span>
+  <span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_session'>session</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be'>be</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>longhash</span><span class='tstring_end'>&#39;</span></span>
+  <span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_session'>session</span><span class='period'>.</span><span class='id identifier rubyid_user'>user</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be'>be</span> <span class='op'>==</span> <span class='int'>1</span>
+<span class='kw'>end</span>
+</code></pre>
+<p>By default Acfs raises an error when a non stubbed resource should be requested. You can switch of the behavior:</p>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_before'>before</span> <span class='kw'>do</span>
+  <span class='const'>Acfs</span><span class='op'>::</span><span class='const'>Stub</span><span class='period'>.</span><span class='id identifier rubyid_allow_requests'>allow_requests</span> <span class='op'>=</span> <span class='kw'>true</span>
+<span class='kw'>end</span>
+<span class='id identifier rubyid_it'>it</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>should find user number one</span><span class='tstring_end'>&#39;</span></span> <span class='kw'>do</span>
+  <span class='id identifier rubyid_user'>user</span> <span class='op'>=</span> <span class='const'>MyUser</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span> <span class='int'>1</span>
+  <span class='const'>Acfs</span><span class='period'>.</span><span class='id identifier rubyid_run'>run</span>             <span class='comment'># Would have raised Acfs::RealRequestNotAllowedError
+</span>                       <span class='comment'># Will run real request to user service instead.
+</span><span class='kw'>end</span>
+</code></pre>
+<h2>Roadmap</h2>
+<ul>
+<li>Update
+<ul>
+<li>Better new? detection eg. storing ETag from request resources.</li>
+<li>Use PATCH for with only changed attributes and <code>If-Unmodifed-Since</code>
+and <code>If-Match</code> header fields if resource was surly loaded from service
+and not created with an id (e.g <code>User.new id: 5, name: &quot;john&quot;</code>).</li>
+<li>Conflict detection (ETag / If-Unmodified-Since)</li>
+</ul></li>
+<li>High level features
+<ul>
+<li>Support for custom mime types on client and server side. (<code>application/vnd.myservice.user.v2+msgpack</code>)</li>
+<li>Server side components
+<ul>
+<li>Reusing model definitions for generating responses?</li>
+<li>Rails responders providing REST operations with integrated ETag,
+Modified Headers, conflict detection, ...</li>
+</ul></li>
+<li>Pagination? Filtering? (If service API provides such features.)</li>
+<li>Messaging Queue support for services and models</li>
+</ul></li>
+<li>Documentation</li>
+</ul>
+<h2>Contributing</h2>
+<ol>
+<li>Fork it</li>
+<li>Create your feature branch (<code>git checkout -b my-new-feature</code>)</li>
+<li>Add specs for your feature</li>
+<li>Implement your feature</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>
+<h2>License</h2>
+<p>MIT License</p>
+<p>Copyright (c) 2013 Jan Graichen. MIT license, see LICENSE for more details.</p>
+</div></div>
+    <div id="footer">
+  Generated on Thu May 23 21:23:35 2013 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.6.1 (ruby-2.0.0).
+</div>
+  </body>
+</html>

data/lib/acfs/version.rb CHANGED

@@ -1,7 +1,7 @@
 module Acfs
   module VERSION
     MAJOR = 0
-    MINOR = 27
+    MINOR = 28
     PATCH = 0
     STAGE = nil

metadata CHANGED

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acfs
 version: !ruby/object:Gem::Version
-  version: 0.27.0.1.b248
+  version: 0.28.0
 platform: ruby
 authors:
 - Jan Graichen
@@ -14,98 +14,98 @@ dependencies:
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.1'
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.1'
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.1'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: typhoeus
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.6.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.6.5
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 description: API Client For Services
@@ -115,20 +115,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
 - CHANGELOG.md
-- Gemfile
-- Guardfile
 - LICENSE
 - README.md
-- Rakefile
 - acfs.gemspec
-- gemfiles/Gemfile.rails-3-0
-- gemfiles/Gemfile.rails-3-1
-- gemfiles/Gemfile.rails-3-2
-- gemfiles/Gemfile.rails-4-0
+- doc/file.README.html
 - lib/acfs.rb
 - lib/acfs/adapter/base.rb
 - lib/acfs/adapter/typhoeus.rb
@@ -177,7 +168,6 @@ files:
 - lib/acfs/stub.rb
 - lib/acfs/version.rb
 - lib/acfs/yard.rb
-- rubydoc.png
 - spec/acfs/configuration_spec.rb
 - spec/acfs/middleware/json_decoder_spec.rb
 - spec/acfs/middleware/msgpack_decoder_spec.rb
@@ -215,14 +205,14 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>'
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project:
 rubygems_version: 2.2.1
@@ -257,3 +247,4 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/response.rb
 - spec/support/service.rb
+has_rdoc:

data/.gitignore DELETED

@@ -1,23 +0,0 @@
-*.gem
-*.rbc
-.rbx
-.bundle
-.config
-.yardoc
-doc
-Gemfile*.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-.idea
-*.iml
-.rvmrc
-.ruby-version

data/.rspec DELETED

	@@ -1,2 +0,0 @@
1	- --color
2	- --backtrace

data/.travis.yml DELETED

@@ -1,29 +0,0 @@
-language: ruby
-bundler_args: --without development
-rvm:
-- 2.1.0
-- 2.0.0
-- 1.9.3
-- jruby
-- rbx
-gemfile:
-- gemfiles/Gemfile.rails-4-0
-- gemfiles/Gemfile.rails-3-2
-- gemfiles/Gemfile.rails-3-1
-services:
-- rabbitmq
-deploy:
-  provider: rubygems
-  api_key:
-    secure: gNudZK0JaRRweudmkpdkJjUMydItTSW5cXjpYdYCfahqd/cD0xPjxotr2TCHrJibfVauoT/PytbQWcP3jnOYytp6oS0up5Y+uKpGmbqVYx/rZvShWALszcBs71lUh/IZpDXNHc+yo/01HCn10/uQUFRtrjWgMwHtHxXb09xE4wQ=
-  gem: acfs
-  on:
-    branch: master
-    repo: jgraichen/acfs
-    rvm: 2.0.0
-matrix:
-  allow_failures:
-    - rvm: 2.1.0
-before_install:
-  - gem install minitest -v '4.7.5'
-  - gem install json -v '1.8.1'

data/Gemfile DELETED

@@ -1,33 +0,0 @@
-source 'https://rubygems.org'
-# Development gems
-#
-gem 'webmock', '~> 1.7'
-gem 'rake'
-gem 'rspec', '>= 3.0.0.beta1'
-gem 'rspec-its'
-gem 'rspec-collection_matchers'
-gem 'coveralls'
-gem 'json', '~> 1.8.1'
-# Doc
-group :development do
-  gem 'yard', '~> 0.8.6'
-  gem 'listen'
-  gem 'guard-yard'
-  gem 'guard-rspec'
-  gem 'redcarpet', platform: :ruby
-end
-# Platform specific development dependencies
-#
-platform :rbx do
-  gem 'rubysl', '~> 2.0'
-  gem 'rubinius-coverage'
-end
-gem 'msgpack', '< 0.5.8', platform: :ruby
-gem 'msgpack-jruby', require: 'msgpack', platform: :jruby
-# Specify your gem's dependencies in acfs.gemspec
-gemroot = File.dirname File.absolute_path __FILE__
-gemspec path: gemroot

data/Guardfile DELETED

@@ -1,14 +0,0 @@
-# A sample Guardfile
-# More info at https://github.com/guard/guard#readme
-guard 'rspec' do
-  watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})          { |m| "spec/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')       { 'spec' }
-  watch(%r{^spec/support/(.+)\.rb$}) { 'spec' }
-end
-guard 'yard' do
-  watch(%r{lib/.+\.rb})
-end

data/Rakefile DELETED

@@ -1,16 +0,0 @@
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec)
-task :default => :spec
-begin
-  require 'yard'
-  require 'yard/rake/yardoc_task'
-  YARD::Rake::YardocTask.new do |t|
-    t.files = %w(lib/**/*.rb)
-    t.options = %w(--output-dir doc/)
-  end
-rescue LoadError
-end

data/gemfiles/Gemfile.rails-3-0 DELETED

@@ -1,8 +0,0 @@
-source 'https://rubygems.org'
-# Load root Gemfile
-self.instance_eval Bundler.read_file 'Gemfile'
-gem 'activesupport', '~> 3.0.0'
-gem 'activemodel', '~> 3.0.0'
-gem 'actionpack', '~> 3.0.0'

data/gemfiles/Gemfile.rails-3-1 DELETED

@@ -1,8 +0,0 @@
-source 'https://rubygems.org'
-# Load root Gemfile
-self.instance_eval Bundler.read_file 'Gemfile'
-gem 'activesupport', '~> 3.1.0'
-gem 'activemodel', '~> 3.1.0'
-gem 'actionpack', '~> 3.1.0'

data/gemfiles/Gemfile.rails-3-2 DELETED

@@ -1,8 +0,0 @@
-source 'https://rubygems.org'
-# Load root Gemfile
-self.instance_eval Bundler.read_file 'Gemfile'
-gem 'activesupport', '~> 3.2.0'
-gem 'activemodel', '~> 3.2.0'
-gem 'actionpack', '~> 3.2.0'

data/gemfiles/Gemfile.rails-4-0 DELETED

@@ -1,8 +0,0 @@
-source 'https://rubygems.org'
-# Load root Gemfile
-self.instance_eval Bundler.read_file 'Gemfile'
-gem 'activesupport', '~> 4.0.0.rc1'
-gem 'activemodel', '~> 4.0.0.rc1'
-gem 'actionpack', '~> 4.0.0.rc1'

data/rubydoc.png DELETED

Binary file