json_roa-client 1.0.0.pre.beta.0 → 1.0.0.pre.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cdb807bb844107ea3e10f62f2abb7e779cec235a
-  data.tar.gz: 0c7ca17cf23edd53294942f1d3b4ab159b8c161c
+  metadata.gz: a343d233e0c8c79b865158eefdfa6294c079ba80
+  data.tar.gz: d3c1da41839add17ac785165b4e3e8696d1352b3
 SHA512:
-  metadata.gz: 8d86b3da965f3688cc2d7d9b44a96b5b98c309266c2d9b34f3ad796d4261e5325ea4ac7d667873f56bc6e6c71daed46e68902fecee7b2ec829a919fe3df7a3c9
-  data.tar.gz: 7bbbe259b42137273fd758374cbe72dfebe8056339b981bcb2a3aec61eea5f6a23c89952cfd63525ae6ecf09ebbe3716ea4325dbc65afdc4b5d745775f1b16ba
+  metadata.gz: f1e660f2cbe03948725619ebee7f7d53467207f64119e693ea60c17f09197d21c9c573d46849dbef057c46ea7ec4e9cf924da18e4d3ad82121441cd858773894
+  data.tar.gz: cdae12606a74ce5a99b3ee3928cab9877500209292f719208db32090f0c22df9d9d49cc09ccc6c69e603a7414aaac5d1db2842d44a09028dc041ab4ff0b98fe5

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format documentation

data/README.md

@@ -9,7 +9,7 @@ A ruby client for `JSON_ROA`.
 ```ruby
 require 'json_roa/client'
 
-@root_resource = JSON_ROA::Client.connect @base_url do |conn|
+@root_relation= JSON_ROA::Client.connect @base_url do |conn|
   conn.basic_auth(@username,@password)
 end
 ```
@@ -19,6 +19,12 @@ end
 
 ###  Resources 
 
+#### Retrieving the Resource of the Root Relation
+
+```ruby
+@root_resource= @root_relation.get()
+```
+
 #### Data
 
 ```ruby

data/json_roa-client.gemspec

@@ -20,11 +20,12 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_development_dependency "pry", '~> 0.10'
+  spec.add_development_dependency 'simplecov', '~> 0.9' 
+  spec.add_development_dependency 'rspec', '~> 3'
 
   spec.add_dependency 'addressable', '~> 2'
   spec.add_dependency 'faraday', '~> 0.9'
   spec.add_dependency 'faraday_middleware', '~> 0.9'
-  # spec.add_dependency "pry", "~> 0.10"
 
 end

data/lib/json_roa/client/relation.rb

@@ -3,11 +3,8 @@ require 'addressable/uri'
 
 module JSON_ROA
   module Client
-
     class Relation
 
-      SUPPORTED_METHODS= %w(get put post delete)
-
       attr_reader :data
       attr_reader :key
 
@@ -15,27 +12,35 @@ module JSON_ROA
         @conn= conn
         @key= key
         @data= data
+
+        Faraday::Connection::METHODS.intersection(available_methods) \
+          .each do |method_name|
+            define_http_method method_name
+          end
       end
 
-      def run_request method, query_parameters, body, headers, &block
-        unless available_methods.keys.include? method
-          raise ArgumentError, "method: #{method} is not supported by this relation"
+      def define_http_method method_name
+        define_singleton_method method_name \
+          do |query_parameters={}, body=nil, headers=nil, &block|
+        run_request method_name, query_parameters, body, headers, &block
         end
+      end
+
+      def run_request method, query_parameters, body, headers, &block
         href= @data['href']
         template= ::Addressable::Template.new(href) 
         expanded_url= template.expand(query_parameters)
-        response=@conn.run_request method.to_sym, expanded_url, body, headers, &block
+        response=@conn.run_request( \
+          method.to_sym, expanded_url, body, headers, &block)
         ::JSON_ROA::Client::Resource.new(@conn,response)
       end
 
-      SUPPORTED_METHODS.each do |method_name|  
-        define_method method_name do |query_parameters={}, body=nil, headers=nil, &block|
-          run_request method_name, query_parameters, body, headers, &block
-        end
+      def available_methods_data
+        @data['methods'] ||= {"get" => {}}
       end
 
       def available_methods
-        @data['methods'] ||= {"get" => {}}
+        available_methods_data.keys.map(&:to_sym)
       end
 
     end

data/lib/json_roa/client/resource.rb

@@ -14,10 +14,15 @@ module JSON_ROA
       end
 
       def relation key
-        relhash= @response.env.json_roa_data['relations'][key]
+        relhash= json_roa_data['relations'][key]
         ::JSON_ROA::Client::Relation.new @conn, key, relhash
       end
 
+      def self_relation
+        ::JSON_ROA::Client::Relation.new( \
+          @conn, "self", json_roa_data['self_relation']) rescue nil
+      end
+
       def data
         @response.body
       end

data/lib/json_roa/client/version.rb

@@ -1,5 +1,5 @@
 module JSON_ROA
   module Client
-    VERSION = "1.0.0-beta.0"
+    VERSION = "1.0.0-beta.1"
   end
 end

data/spec/api_query_spec.rb

@@ -0,0 +1,46 @@
+require_relative 'spec_helper.rb'
+
+
+describe "API: traversing from root to resource to some relation"  do
+
+  describe "root relation" do
+
+    let :root_relation do 
+      JSON_ROA::Client.connect("/")
+    end
+
+    describe "root_resource via get"  do
+
+      subject(:root_resource) {root_relation.get() }
+
+      it do 
+        expect(root_resource.class).to be== JSON_ROA::Client::Resource
+      end
+
+      describe "data" do
+        subject(:data) {root_resource.data}
+
+       it do
+         expect(data).to be== {"x" => 42}
+       end
+
+      end
+
+      describe "task relation " do
+        subject(:task_relation) { root_resource.relation('task')}
+
+        it "is of class Relation" do
+          expect(task_relation.class).to be== JSON_ROA::Client::Relation
+        end
+        
+        it "responds to get" do
+          expect(task_relation.respond_to? :get).to be
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/spec/collection_spec.rb

@@ -0,0 +1,49 @@
+require_relative 'spec_helper.rb'
+
+describe JSON_ROA::Client::Collection do
+
+  let :root_relation do 
+    JSON_ROA::Client.connect("/")
+  end
+
+  describe "tasks resource via get" do
+    subject(:tasks_resource) {root_relation.get().relation('tasks').get() }
+
+    it "is a resource" do
+      expect(tasks_resource.class).to be== JSON_ROA::Client::Resource
+    end
+
+    it "responds to collection" do
+      expect(tasks_resource.respond_to? :collection).to be
+    end
+
+    describe "tasks collection" do
+      subject(:tasks_collection) {tasks_resource.collection}
+
+      it "is a collection" do
+        expect(tasks_collection.class).to be== JSON_ROA::Client::Collection
+      end
+
+      it "has exactly one element" do 
+        expect(tasks_collection.count).to be== 1
+      end
+
+      describe "the first task" do
+        subject(:first_task) {tasks_collection.first}
+
+        it "is a relation" do
+          expect(first_task.class).to be== JSON_ROA::Client::Relation
+        end
+
+        it "leads to /task/t1" do
+          expect(first_task.data["href"]).to be== "/tasks/t1"
+        end
+
+      end
+
+    end
+
+  end
+
+end
+

data/spec/connect_spec.rb

@@ -0,0 +1,21 @@
+require 'rspec'
+require 'json_roa/client'
+require 'pry'
+
+describe JSON_ROA::Client do
+  context "when calling connect" do
+
+    it "returns an instance of JSON_ROA::Client::Relation" do
+      expect(JSON_ROA::Client.connect("http://example.com").class).to \
+        be== JSON_ROA::Client::Relation
+    end
+
+    it "exposes Faraday::Connection via the block" do
+      JSON_ROA::Client.connect("http://example.com") do |conn|
+        expect(conn.class).to be== Faraday::Connection
+      end
+    end
+
+  end
+end
+

data/spec/data/root.yml

@@ -0,0 +1,12 @@
+x: 42
+_json-roa: 
+  version: 0.0.0
+  relations: 
+    tasks:
+      href: /tasks/
+    task: 
+      href: /tasks/{id}
+      methods:
+        get: {}
+        put: {}
+        delete: {}

data/spec/data/task1.yml

@@ -0,0 +1,13 @@
+state: 'done'
+_json-roa: 
+  version: 0.0.0
+  self_relation: 
+    href: /tasks/t1
+    methods:
+      get: {}
+      put: {}
+      delete: {}
+  relations: 
+    tasks:
+      href: /tasks/
+

data/spec/data/tasks_page0.yml

@@ -0,0 +1,11 @@
+tasks:
+  - id: "t1"
+_json-roa:
+  relations:
+    root: /
+  collection:
+    next: 
+      href: /tasks/?page=1
+    relations:
+      0: 
+        href: /tasks/t1

data/spec/data/tasks_page1.yml

@@ -0,0 +1,7 @@
+tasks: []
+_json-roa:
+  version: 0.0.0
+  relations:
+    root: /
+  collection:
+    relations: {}

data/spec/methods_spec.rb

@@ -0,0 +1,30 @@
+require_relative 'spec_helper.rb'
+
+describe "methods of the relation /tasks/t1" do
+
+  let :root_relation do 
+    JSON_ROA::Client.connect("/")
+  end
+
+  subject(:task1_self_relation) \
+    {root_relation.get().relation("task").get(id: "t1").self_relation}
+
+  it "is a relation" do 
+    expect(task1_self_relation.class).to be== JSON_ROA::Client::Relation
+  end
+
+  describe "defined get" do
+    it "does not raise" do
+      expect{task1_self_relation.get()}.not_to raise_error
+    end
+  end
+
+  describe "not defined post" do
+    it "does raise" do
+      expect{task1_self_relation.post()}.to raise_error
+    end
+  end
+
+end
+
+

data/spec/spec_helper.rb

@@ -0,0 +1,65 @@
+require 'simplecov'
+SimpleCov.start
+
+require 'faraday'
+require 'rspec'
+require 'pry'
+require 'YAML'
+require 'json_roa/client'
+
+module JSON_ROA
+  module Client
+
+    class Relation
+      attr_accessor :conn
+    end
+
+    class << self
+      alias_method :original_connect, :connect
+
+      def connect url, &block
+        res= original_connect url, &block
+        res.conn= test_api
+        res
+      end
+
+    end
+  end
+end
+
+
+def root_data 
+  YAML.load_file(File.expand_path("./data/root.yml",
+                                  File.dirname(__FILE__)))
+end
+
+def tasks_page0_data 
+  YAML.load_file( File.expand_path("./data/tasks_page0.yml",
+                                   File.dirname(__FILE__)))
+end
+
+def tasks_page1_data
+  YAML.load_file( File.expand_path("./data/tasks_page1.yml",
+                                   File.dirname(__FILE__)))
+end
+
+def task1_data 
+  YAML.load_file( File.expand_path("./data/task1.yml",
+                                   File.dirname(__FILE__)))
+end
+
+
+def test_api
+  Faraday.new do |conn|
+    headers= {content_type: "application/json-roa+json"}
+    conn.use ::JSON_ROA::Middleware
+    conn.response :json, :content_type => /\bjson$/
+    conn.adapter :test do |stub|
+      stub.get('/') { |env| [ 200, headers, root_data.to_json]}
+      stub.get('/tasks/') { |env| [ 200, headers, tasks_page0_data.to_json]}
+      stub.get('/tasks/?page=0') { |env| [ 200, headers, tasks_page0_data.to_json]}
+      stub.get('/tasks/?page=1') { |env| [ 200, headers, tasks_page1_data.to_json]}
+      stub.get('/tasks/t1') { |env| [ 200, headers, task1_data.to_json]}
+    end
+  end
+end

data/spec/template_expansion_spec.rb

@@ -0,0 +1,31 @@
+require_relative 'spec_helper.rb'
+
+describe "template expansion of task with id" do
+
+  let :root_relation do 
+    JSON_ROA::Client.connect("/")
+  end
+
+  subject(:task_relation) {root_relation.get().relation("task")}
+
+  it "is a relation" do 
+    expect(task_relation.class).to be== JSON_ROA::Client::Relation
+  end
+
+  it "is templated" do
+    expect(task_relation.data['href']).to be== "/tasks/{id}"
+  end
+
+  describe "get with parameter to expand" do
+    subject(:task_resource){task_relation.get(id: "t1")}
+
+    it "is a resource of t1" do
+      expect(task_resource.class).to be== JSON_ROA::Client::Resource
+      expect(task_resource.self_relation.data["href"]).to be== "/tasks/t1"
+    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.pre.beta.0
+  version: 1.0.0.pre.beta.1
 platform: ruby
 authors:
 - Thomas Schank
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-01 00:00:00.000000000 Z
+date: 2014-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
@@ -102,6 +130,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -112,6 +141,16 @@ files:
 - lib/json_roa/client/relation.rb
 - lib/json_roa/client/resource.rb
 - lib/json_roa/client/version.rb
+- spec/api_query_spec.rb
+- spec/collection_spec.rb
+- spec/connect_spec.rb
+- spec/data/root.yml
+- spec/data/task1.yml
+- spec/data/tasks_page0.yml
+- spec/data/tasks_page1.yml
+- spec/methods_spec.rb
+- spec/spec_helper.rb
+- spec/template_expansion_spec.rb
 homepage: ''
 licenses:
 - MIT
@@ -136,4 +175,14 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: The Ruby JSON-ROA Client Reference Implementation
-test_files: []
+test_files:
+- spec/api_query_spec.rb
+- spec/collection_spec.rb
+- spec/connect_spec.rb
+- spec/data/root.yml
+- spec/data/task1.yml
+- spec/data/tasks_page0.yml
+- spec/data/tasks_page1.yml
+- spec/methods_spec.rb
+- spec/spec_helper.rb
+- spec/template_expansion_spec.rb