json_roa-client 1.0.0 → 2.0.0.pre.beta.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9b48bd9fee8fa88a388136211e2b6fcadbb635ba
-  data.tar.gz: 487226246eb7481ccbefd741c5d35dbc2c4cd3db
+  metadata.gz: b662e7a8d461187981a2aac649bd983d79143018
+  data.tar.gz: b0e49acb1a34f43de026289053fe32fa9614c1b8
 SHA512:
-  metadata.gz: 289c5648a42ddcc4a39a7b3b606d233a7560c53c054703869721731acb2af6a71f196d6b194f988605af0886e3a5c40ef2092e270cbe3632ead68a186b28d1bc
-  data.tar.gz: d713aab8bf657eafc4f7fbf1d4b5147d29dce8c46e055cf3352a08f1f0efb90e2c17b370cfab1e792e538e36614c53857772e72a9beef160823de9002f6fddf4
+  metadata.gz: 63da467aa778be163c89bf25431758bb345c898ace2a32ffab7e4f0d078f2e89f4a6b28700341b532571bffa6ab6a41979787ad6ace2f0c0b49ae5958b8b088c
+  data.tar.gz: d2704f33acca5058450154f10a282572b22685277e277b6506ee4f7f2e93b820c66b9a24b63a8c30d70141103fc7365d0a8f8db3f7c95874a35cde23ad6a70df

data/.gitignore

@@ -1,3 +1,8 @@
+*.a
+*.bundle
+*.gem
+*.o
+*.so
 /.bundle/
 /.yardoc
 /Gemfile.lock
@@ -7,8 +12,4 @@
 /pkg/
 /spec/reports/
 /tmp/
-*.bundle
-*.so
-*.o
-*.a
 mkmf.log

data/.rubocop.yml

@@ -174,6 +174,3 @@ Rails/Validation:
 Style/ClassAndModuleCamelCase:
   Enabled: false
 
-# Offense count: 2
-Style/RegexpLiteral:
-  MaxSlashes: 0

data/lib/json_roa/client.rb

@@ -5,30 +5,66 @@ require 'faraday_middleware'
 
 module JSON_ROA
 
+  class VersionError < StandardError
+  end
+
   class Middleware < Faraday::Middleware
     def call(env)
       @app.call(env).on_complete do |env|
         env.class.class_eval do |klass|
           attr_accessor :json_roa_data
         end
-        env.json_roa_data = env.body.delete('_json-roa')
+        content_type = env.response_headers['content-type']
+        if  content_type  && content_type =~ /json-roa/
+          if env.body.is_a? Array
+            env.json_roa_data = env.body.first
+            env.body.delete_at 0
+          elsif env.body.is_a? Hash
+            env.json_roa_data = env.body.delete('_json-roa')
+          end
+          json_roa_version = env.json_roa_data['json-roa_version']
+          major_version =
+            begin
+              Integer(/^(\d+).*/.match(json_roa_version)[1])
+            rescue StandardError
+              raise VersionError,
+                'Failed to infer the major number of the JSON-ROA data.'
+            end
+          unless major_version == 1
+            raise VersionError, 'The major version' \
+              " #{major_version} is not supported by this client."
+          end
+        end
       end
     end
   end
 
   module Client
 
+    DEFAULT_OPTIONS = {
+      adapter: Faraday.default_adapter,
+      raise_error: true,
+      retry: true
+    }
+
     class << self
 
-      def connect(url, &_block)
+      def connect(url, options = {}, &_block)
+        options = DEFAULT_OPTIONS.merge(options)
         @conn = Faraday.new(
           url: url,
           headers: { accept: 'application/json-roa+json' }) do |conn|
             conn.use ::JSON_ROA::Middleware
             conn.response :json, content_type: /\bjson$/
-            conn.request :retry
-            conn.use Faraday::Response::RaiseError
-            conn.adapter Faraday.default_adapter
+            if options[:retry]
+              conn.request :retry
+            end
+            if options[:raise_error]
+              conn.use Faraday::Response::RaiseError
+            end
+            if options[:adapter]
+              conn.adapter options[:adapter]
+            end
           end
 
         yield @conn if block_given?

data/lib/json_roa/client/version.rb

@@ -1,5 +1,5 @@
 module JSON_ROA
   module Client
-    VERSION = '1.0.0'
+    VERSION = '2.0.0-beta.3'
   end
 end

data/spec/api_query_spec.rb

@@ -1,6 +1,6 @@
 require_relative 'spec_helper.rb'
 
-describe 'API: traversing from root to resource to some relation'  do
+describe 'API: traversing from root to resource to some relation' do
 
   describe 'root relation' do
 
@@ -8,7 +8,7 @@ describe 'API: traversing from root to resource to some relation'  do
       JSON_ROA::Client.connect('/')
     end
 
-    describe 'root_resource via get'  do
+    describe 'root_resource via get' do
 
       subject(:root_resource) { root_relation.get }
 

data/spec/array_query_spec.rb

@@ -0,0 +1,19 @@
+require_relative 'spec_helper.rb'
+
+describe 'API: requesting an array object' do
+
+  describe 'array relation' do
+
+    let :array do
+      JSON_ROA::Client.connect('/array')
+    end
+
+    describe 'array_resource via get' do
+
+      it do
+        expect(array.get.data).to be == [{ 'x' => 42 }]
+      end
+
+    end
+  end
+end

data/spec/data/array.yml

@@ -0,0 +1,3 @@
+- json-roa_version: "1.0.0"
+
+- x: 42

data/spec/data/root.yml

@@ -1,6 +1,6 @@
 x: 42
 _json-roa: 
-  version: 0.0.0
+  json-roa_version: 1.0.0
   relations: 
     tasks:
       href: /tasks/{?x,y}
@@ -10,3 +10,5 @@ _json-roa:
         get: {}
         put: {}
         delete: {}
+    some_array:
+      href: /array

data/spec/data/task1.yml

@@ -1,6 +1,6 @@
 state: 'done'
 _json-roa: 
-  version: 0.0.0
+  json-roa_version: 1.0.0
   self_relation: 
     href: /tasks/t1
     methods:

data/spec/data/tasks_page0.yml

@@ -1,6 +1,7 @@
 tasks:
   - id: "t1"
 _json-roa:
+  json-roa_version: 1.0.0
   relations:
     root: /
   collection:

data/spec/data/tasks_page1.yml

@@ -1,6 +1,6 @@
 tasks: []
 _json-roa:
-  version: 0.0.0
+  json-roa_version: 1.0.0
   relations:
     root: /
   collection:

data/spec/spec_helper.rb

@@ -27,24 +27,29 @@ module JSON_ROA
   end
 end
 
+def load_yaml_file(filepath)
+  YAML.load_file(
+    File.expand_path(filepath, File.dirname(__FILE__)))
+end
+
 def root_data
-  YAML.load_file(File.expand_path('./data/root.yml',
-                                  File.dirname(__FILE__)))
+  load_yaml_file './data/root.yml'
 end
 
 def tasks_page0_data
-  YAML.load_file(File.expand_path('./data/tasks_page0.yml',
-                                  File.dirname(__FILE__)))
+  load_yaml_file './data/tasks_page0.yml'
 end
 
 def tasks_page1_data
-  YAML.load_file(File.expand_path('./data/tasks_page1.yml',
-                                  File.dirname(__FILE__)))
+  load_yaml_file './data/tasks_page1.yml'
 end
 
 def task1_data
-  YAML.load_file(File.expand_path('./data/task1.yml',
-                                  File.dirname(__FILE__)))
+  load_yaml_file './data/task1.yml'
+end
+
+def array_data
+  load_yaml_file './data/array.yml'
 end
 
 def test_api
@@ -68,6 +73,18 @@ def test_api
       stub.get('/tasks/t1') do |env|
         [200, headers, task1_data.to_json]
       end
+      stub.get('/array') do |env|
+        [200, headers, array_data.to_json]
+      end
+      stub.get('/missing-version') do |env|
+        [200, headers, { '_json-roa' => {} }]
+      end
+      stub.get('/malformed-version') do |env|
+        [200, headers, { '_json-roa' => { 'json-roa_version' => 'X1.0.0' } }]
+      end
+      stub.get('/incompatible-version') do |env|
+        [200, headers, { '_json-roa' => { 'json-roa_version' => '5.0.0' } }]
+      end
     end
   end
 end

data/spec/version_check_spec.rb

@@ -0,0 +1,28 @@
+require_relative 'spec_helper.rb'
+
+describe 'version check' do
+
+  describe 'missing version' do
+    it 'raises' do
+      expect do
+        JSON_ROA::Client.connect('/missing-version').get
+      end.to raise_error JSON_ROA::VersionError
+    end
+  end
+
+  describe 'malformed version' do
+    it 'raises' do
+      expect do
+        JSON_ROA::Client.connect('/malformed-version').get
+      end.to raise_error JSON_ROA::VersionError
+    end
+  end
+
+  describe 'incompatible version' do
+    it 'raises' do
+      expect do
+        JSON_ROA::Client.connect('/incompatible-version').get
+      end.to raise_error JSON_ROA::VersionError
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_roa-client
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0.pre.beta.3
 platform: ruby
 authors:
 - Thomas Schank
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-14 00:00:00.000000000 Z
+date: 2015-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -171,8 +171,10 @@ files:
 - lib/json_roa/client/resource.rb
 - lib/json_roa/client/version.rb
 - spec/api_query_spec.rb
+- spec/array_query_spec.rb
 - spec/collection_spec.rb
 - spec/connect_spec.rb
+- spec/data/array.yml
 - spec/data/root.yml
 - spec/data/task1.yml
 - spec/data/tasks_page0.yml
@@ -180,6 +182,7 @@ files:
 - spec/methods_spec.rb
 - spec/spec_helper.rb
 - spec/template_expansion_spec.rb
+- spec/version_check_spec.rb
 homepage: ''
 licenses:
 - MIT
@@ -195,9 +198,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.2
@@ -206,8 +209,10 @@ specification_version: 4
 summary: The Ruby JSON-ROA Client Reference Implementation
 test_files:
 - spec/api_query_spec.rb
+- spec/array_query_spec.rb
 - spec/collection_spec.rb
 - spec/connect_spec.rb
+- spec/data/array.yml
 - spec/data/root.yml
 - spec/data/task1.yml
 - spec/data/tasks_page0.yml
@@ -215,3 +220,5 @@ test_files:
 - spec/methods_spec.rb
 - spec/spec_helper.rb
 - spec/template_expansion_spec.rb
+- spec/version_check_spec.rb
+has_rdoc: